From b9c80d0c26f0b316294918c3cdf088c5084b88e8 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Wed, 22 Feb 2012 19:46:32 +0900 Subject: [PATCH] =?utf8?q?CHANGE:=20Link=E3=82=AF=E3=83=A9=E3=82=B9?= =?utf8?q?=E3=82=92=E5=8F=82=E7=85=A7=E3=81=9B=E3=81=9A=E3=81=ABglobalfunc?= =?utf8?q?tions.php=E3=81=AE=E3=83=A9=E3=83=83=E3=83=91=E3=83=BC=E9=96=A2?= =?utf8?q?=E6=95=B0=E3=82=92=E5=8F=82=E7=85=A7=E3=81=97=E3=81=A6=E3=81=84?= =?utf8?q?=E3=82=8B=E3=82=B9=E3=82=AF=E3=83=AA=E3=83=97=E3=83=88=E3=82=92?= =?utf8?q?=E4=BF=AE=E6=AD=A3=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit 合わせて、Linkクラスのメソッドをコードフォーマットに従って名前変更。PHP docも修正・加筆。 --- nucleus/documentation/devdocs/plugins.html | 14 +++---- nucleus/documentation/help.html | 2 +- nucleus/libs/ACTION.php | 8 ++-- nucleus/libs/ACTIONS.php | 20 +++++----- nucleus/libs/BLOG.php | 18 ++++----- nucleus/libs/COMMENTACTIONS.php | 4 +- nucleus/libs/COMMENTS.php | 2 +- nucleus/libs/ITEMACTIONS.php | 10 ++--- nucleus/libs/Link.php | 61 ++++++++++++++++++++---------- nucleus/libs/globalfunctions.php | 42 +++++++++++--------- 10 files changed, 102 insertions(+), 79 deletions(-) diff --git a/nucleus/documentation/devdocs/plugins.html b/nucleus/documentation/devdocs/plugins.html index c299b6d..0abaf3a 100644 --- a/nucleus/documentation/devdocs/plugins.html +++ b/nucleus/documentation/devdocs/plugins.html @@ -2230,7 +2230,7 @@ Make the init method in the plugin like below include_once($this->getDirectory().'english.php'); } -This logic is same as Nucleus’ language file setting. +This logic is same as Nucleus' language file setting.
  • Add language files As English is the default language, it is recommended to have at least the English version.
    • @@ -2336,7 +2336,7 @@ and global variables described below:

    Returns the full system path where the extra files for the plugin are stored (if there are no such files, this information makes no sense). The result is something like ".../nucleus/plugins/plugname/" - createItemLink($itemid, $extra = '') + Link::create_item_link($itemid, $extra = '') Global function $itemid Integer. ID of item being linked.
    $extra Associative Array. Containing key-value pairs corresponding to additional parameters-values that should appear in the link. @@ -2344,7 +2344,7 @@ and global variables described below:

    Returns the full URL, in scheme chosen by user, of item indicated by $itemid - createMemberLink($memberid, $extra = '') + Link::create_member_link($memberid, $extra = '') Global function $memberid Integer. ID of member being linked.
    $extra Associative Array. Containing key-value pairs corresponding to additional parameters-values that should appear in the link. @@ -2352,7 +2352,7 @@ and global variables described below:

    Returns the full URL, in scheme chosen by user, of member page indicated by $memberid - createCategoryLink($catid, $extra = '') + Link::create_category_link($catid, $extra = '') Global function $catid Integer. ID of category being linked.
    $extra Associative Array. Containing key-value pairs corresponding to additional parameters-values that should appear in the link. @@ -2360,7 +2360,7 @@ and global variables described below:

    Returns the full URL, in scheme chosen by user, of category index page indicated by $catid - createArchiveListLink($blogid = '', $extra = '') + create_archivelist_link($blogid = '', $extra = '') Global function $blogid Integer. ID of blog whose archivelist is being linked.
    $extra Associative Array. Containing key-value pairs corresponding to additional parameters-values that should appear in the link. @@ -2368,7 +2368,7 @@ and global variables described below:

    Returns the full URL, in scheme chosen by user, of archivelist page indicated by $blogid - createArchiveLink($blogid, $archive, $extra = '') + create_archive_link($blogid, $archive, $extra = '') Global function $blogid Integer. ID of blog whose archive is being linked.
    $archive String. Valid archive parameter for date (year-month) being linked.
    @@ -2377,7 +2377,7 @@ and global variables described below:

    Returns the full URL, in scheme chosen by user, of archive page indicated by $blogid and $archive - createBlogidLink($blogid, $extra = '') + create_blogid_link($blogid, $extra = '') Global function $blogid Integer. ID of blog being linked.
    $extra Associative Array. Containing key-value pairs corresponding to additional parameters-values that should appear in the link. diff --git a/nucleus/documentation/help.html b/nucleus/documentation/help.html index 5c18c0a..1a3ebcd 100644 --- a/nucleus/documentation/help.html +++ b/nucleus/documentation/help.html @@ -657,7 +657,7 @@ bloglist footer Description bloglink - URL of the blog (as generated by createBlogIdLink() function) + URL of the blog (as generated by Link::create_blogid_link() function) blogurl URL of the blog (as defined in blogsettings) diff --git a/nucleus/libs/ACTION.php b/nucleus/libs/ACTION.php index 5809bbd..065d321 100644 --- a/nucleus/libs/ACTION.php +++ b/nucleus/libs/ACTION.php @@ -124,7 +124,7 @@ class ACTION } else { - $url = createItemLink($post['itemid']); + $url = Link::create_item_link($post['itemid']); redirect($url); } // end if @@ -189,11 +189,11 @@ class ACTION if ( $CONF['URLMode'] == 'pathinfo' ) { - $url = createLink('member', array('memberid' => $tomem->getID(), 'name' => $tomem->getDisplayName() ) ); + $url = Link::create_link('member', array('memberid' => $tomem->getID(), 'name' => $tomem->getDisplayName() ) ); } else { - $url = $CONF['IndexURL'] . createMemberLink($tomem->getID()); + $url = $CONF['IndexURL'] . Link::create_member_link($tomem->getID()); } redirect($url); @@ -390,7 +390,7 @@ class ACTION if ( $blog->getNotifyAddress() && $blog->notifyOnVote() ) { $message = _NOTIFY_KV_MSG . ' ' . $itemid . "\n"; - $itemLink = createItemLink(intval($itemid) ); + $itemLink = Link::create_item_link(intval($itemid) ); $temp = parse_url($itemLink); if ( !$temp['scheme'] ) diff --git a/nucleus/libs/ACTIONS.php b/nucleus/libs/ACTIONS.php index 4a57b0f..ec276af 100644 --- a/nucleus/libs/ACTIONS.php +++ b/nucleus/libs/ACTIONS.php @@ -362,7 +362,7 @@ class ACTIONS extends BaseActions { function _itemlink($id, $linktext = '') { global $CONF; if ($id) - echo $this->_link(createItemLink($id, $this->linkparams), $linktext); + echo $this->_link(Link::create_item_link($id, $this->linkparams), $linktext); else $this->parse_todaylink($linktext); } @@ -373,7 +373,7 @@ class ACTIONS extends BaseActions { function _archivelink($id, $linktext = '') { global $CONF, $blog; if ($id) - echo $this->_link(createArchiveLink($blog->getID(), $id, $this->linkparams), $linktext); + echo $this->_link(Link::create_archive_link($blog->getID(), $id, $this->linkparams), $linktext); else $this->parse_todaylink($linktext); } @@ -515,9 +515,9 @@ class ACTIONS extends BaseActions { function parse_archivelink($linktext = '') { global $blog, $CONF; if ($blog) - echo $this->_link(createArchiveListLink($blog->getID(),$this->linkparams), $linktext); + echo $this->_link(Link::create_archivelist_link($blog->getID(),$this->linkparams), $linktext); else - echo $this->_link(createArchiveListLink(), $linktext); + echo $this->_link(Link::create_archivelist_link(), $linktext); } function parse_archivelist($template, $category = 'all', $limit = 0) { @@ -682,7 +682,7 @@ class ACTIONS extends BaseActions { if (!$destinationurl) { - $destinationurl = createLink( + $destinationurl = Link::create_link( 'item', array( 'itemid' => $itemid, @@ -955,9 +955,9 @@ class ACTIONS extends BaseActions { break; case 'yourprofileurl': if ($CONF['URLMode'] == 'pathinfo') - echo createMemberLink($member->getID()); + echo Link::create_member_link($member->getID()); else - echo $CONF['IndexURL'] . createMemberLink($member->getID()); + echo $CONF['IndexURL'] . Link::create_member_link($member->getID()); break; } } @@ -972,9 +972,9 @@ class ACTIONS extends BaseActions { if ($desturl == '') { if ($CONF['URLMode'] == 'pathinfo') - $desturl = createMemberLink($memberid); + $desturl = Link::create_member_link($memberid); else - $desturl = $CONF['IndexURL'] . createMemberLink($memberid); + $desturl = $CONF['IndexURL'] . Link::create_member_link($memberid); } $message = postVar('message'); @@ -1368,7 +1368,7 @@ class ACTIONS extends BaseActions { function parse_todaylink($linktext = '') { global $blog, $CONF; if ($blog) - echo $this->_link(createBlogidLink($blog->getID(),$this->linkparams), $linktext); + echo $this->_link(Link::create_blogid_link($blog->getID(),$this->linkparams), $linktext); else echo $this->_link($CONF['SiteUrl'], $linktext); } diff --git a/nucleus/libs/BLOG.php b/nucleus/libs/BLOG.php index 1d6da8d..cc1fc7a 100644 --- a/nucleus/libs/BLOG.php +++ b/nucleus/libs/BLOG.php @@ -320,7 +320,7 @@ class BLOG { $temp = parse_url($CONF['Self']); if ( $temp['scheme'] ) { - $message .= createItemLink($itemid) . "\n\n"; + $message .= Link::create_item_link($itemid) . "\n\n"; } else { @@ -641,7 +641,7 @@ class BLOG { $data['year'] = date('Y',$current->itime); $archive['year'] = $data['year']; - $data['archivelink'] = createArchiveLink($this->getID(),$archivedate,$linkparams); + $data['archivelink'] = Link::create_archive_link($this->getID(),$archivedate,$linkparams); $manager->notify( 'PreArchiveListItem', @@ -675,20 +675,17 @@ class BLOG { $linkparams = array(); if ($archive) { - $blogurl = createArchiveLink($this->getID(), $archive, ''); + $blogurl = Link::create_archive_link($this->getID(), $archive, ''); $linkparams['blogid'] = $this->getID(); $linkparams['archive'] = $archive; } else if ($archivelist) { - $blogurl = createArchiveListLink($this->getID(), ''); + $blogurl = Link::create_archivelist_link($this->getID(), ''); $linkparams['archivelist'] = $archivelist; } else { - $blogurl = createBlogidLink($this->getID(), ''); + $blogurl = Link::create_blogid_link($this->getID(), ''); $linkparams['blogid'] = $this->getID(); } - //$blogurl = $this->getURL() . $qargs; - //$blogurl = createBlogLink($this->getURL(), $linkparams); - $template =& $manager->getTemplate($template); //: Change: Set nocatselected variable @@ -716,7 +713,7 @@ class BLOG { while ($data = sql_fetch_assoc($res)) { $data['blogid'] = $this->getID(); $data['blogurl'] = $blogurl; - $data['catlink'] = createLink( + $data['catlink'] = Link::create_link( 'category', array( 'catid' => $data['catid'], @@ -836,8 +833,7 @@ class BLOG { $list = array(); -// $list['bloglink'] = createLink('blog', array('blogid' => $data['bnumber'])); - $list['bloglink'] = createBlogidLink($data['bnumber']); + $list['bloglink'] = Link::create_blogid_link($data['bnumber']); $list['blogdesc'] = $data['bdesc']; diff --git a/nucleus/libs/COMMENTACTIONS.php b/nucleus/libs/COMMENTACTIONS.php index 6e0064a..7c21b4a 100644 --- a/nucleus/libs/COMMENTACTIONS.php +++ b/nucleus/libs/COMMENTACTIONS.php @@ -119,7 +119,7 @@ class COMMENTACTIONS extends BaseActions { $comment['userid'] = $mem->getEmail(); } - $comment['userlinkraw'] = createLink( + $comment['userlinkraw'] = Link::create_link( 'member', array( 'memberid' => $comment['memberid'], @@ -269,7 +269,7 @@ class COMMENTACTIONS extends BaseActions { * Parse templatevar itemlink */ function parse_itemlink() { - echo createLink( + echo Link::create_link( 'item', array( 'itemid' => $this->commentsObj->itemid, diff --git a/nucleus/libs/COMMENTS.php b/nucleus/libs/COMMENTS.php index e3db729..8f73266 100644 --- a/nucleus/libs/COMMENTS.php +++ b/nucleus/libs/COMMENTS.php @@ -280,7 +280,7 @@ class COMMENTS { if ( $temp['scheme'] ) { - $message .= createItemLink($this->itemid) . "\n\n"; + $message .= Link::create_item_link($this->itemid) . "\n\n"; } else { diff --git a/nucleus/libs/ITEMACTIONS.php b/nucleus/libs/ITEMACTIONS.php index 87dfc29..1d2bb07 100644 --- a/nucleus/libs/ITEMACTIONS.php +++ b/nucleus/libs/ITEMACTIONS.php @@ -179,7 +179,7 @@ class ITEMACTIONS extends BaseActions { * Parse templatevar categorylink */ function parse_categorylink() { - echo createLink('category', array('catid' => $this->currentItem->catid, 'name' => $this->currentItem->category)); + echo Link::create_link('category', array('catid' => $this->currentItem->catid, 'name' => $this->currentItem->category)); } /** @@ -200,7 +200,7 @@ class ITEMACTIONS extends BaseActions { * Parse templatevar authorlink */ function parse_authorlink() { - echo createLink( + echo Link::create_link( 'member', array( 'memberid' => $this->currentItem->authorid, @@ -221,7 +221,7 @@ class ITEMACTIONS extends BaseActions { * Parse templatevar itemlink */ function parse_itemlink() { - echo createLink( + echo Link::create_link( 'item', array( 'itemid' => $this->currentItem->itemid, @@ -441,7 +441,7 @@ class ITEMACTIONS extends BaseActions { * Parse templatevar daylink */ function parse_daylink() { - echo createArchiveLink($this->blog->getID(), i18n::strftime('%Y-%m-%d',$this->currentItem->timestamp), $this->linkparams); + echo Link::create_archive_link($this->blog->getID(), i18n::strftime('%Y-%m-%d',$this->currentItem->timestamp), $this->linkparams); } /** @@ -785,4 +785,4 @@ class ITEMACTIONS extends BaseActions { } -?> \ No newline at end of file +?> diff --git a/nucleus/libs/Link.php b/nucleus/libs/Link.php index 98254cb..c1e8882 100644 --- a/nucleus/libs/Link.php +++ b/nucleus/libs/Link.php @@ -13,84 +13,99 @@ * This class is a collections of functions that produce links * * All functions in this clss should only be called statically, - * for example: Link::createItemLink(...) + * for example: Link::create_item_link(...) * * @license http://nucleuscms.org/license.txt GNU General Public License * @copyright Copyright (C) 2002-2011 The Nucleus Group * @version $Id: $ */ -class Link { +class Link +{ /** + * Link::create_item_link() * Create a link to an item + * @static * @param $itemid item id * @param $extra extra parameter */ - function createItemLink($itemid, $extra = '') { - return Link::createLink('item', array('itemid' => $itemid, 'extra' => $extra) ); + static public function create_item_link($itemid, $extra = '') { + return self::create_link('item', array('itemid' => $itemid, 'extra' => $extra) ); } /** + * Link::create_member_link() * Create a link to a member * + * @static * @param $memberid member id * @param $extra extra parameter */ - function createMemberLink($memberid, $extra = '') { - return Link::createLink('member', array('memberid' => $memberid, 'extra' => $extra) ); + static public function create_member_link($memberid, $extra = '') { + return self::create_link('member', array('memberid' => $memberid, 'extra' => $extra) ); } /** + * Link::create_category_link() * Create a link to a category * + * @static * @param $catid category id * @param $extra extra parameter */ - function createCategoryLink($catid, $extra = '') { - return Link::createLink('category', array('catid' => $catid, 'extra' => $extra) ); + static public function create_category_link($catid, $extra = '') { + return self::create_link('category', array('catid' => $catid, 'extra' => $extra) ); } /** + * Link::cteate_archive_link() * Create a link to an archive * + * @static * @param $blogid blog id * @param $archive archive identifier * @param $extra extra parameter */ - function createArchiveLink($blogid, $archive, $extra = '') { - return Link::createLink('archive', array('blogid' => $blogid, 'archive' => $archive, 'extra' => $extra) ); + static public function create_archive_link($blogid, $archive, $extra = '') { + return self::create_link('archive', array('blogid' => $blogid, 'archive' => $archive, 'extra' => $extra) ); } /** + * Link::create_archivelist_link() * Create a link to an archive list * + * @static * @param $blogid blog id * @param $extra extra parameter */ - function createArchiveListLink($blogid = '', $extra = '') { - return Link::createLink('archivelist', array('blogid' => $blogid, 'extra' => $extra) ); + static public function create_archivelist_link($blogid = '', $extra = '') { + return self::create_link('archivelist', array('blogid' => $blogid, 'extra' => $extra) ); } /** + * Link::create_blogid_link() * Create a link to a blog * + * @static * @param $blogid blog id * @param $extra extra parameter */ - function createBlogidLink($blogid, $params = '') { - return Link::createLink('blog', array('blogid' => $blogid, 'extra' => $params) ); + static public function create_blogid_link($blogid, $params = '') { + return self::create_link('blog', array('blogid' => $blogid, 'extra' => $params) ); } /** + * Link::create_link() * Create a link * * Universell function that creates link of different types (like item, blog ...) * and with an array of parameters * + * @static * @param $type type of the link * @param $params array with parameters */ - function createLink($type, $params) { + static public function create_link($type, $params) { global $manager, $CONF; $generatedURL = ''; @@ -99,7 +114,8 @@ class Link { // ask plugins first $created = false; - if ($usePathInfo) { + if ($usePathInfo) + { $manager->notify( 'GenerateURL', array( @@ -112,7 +128,8 @@ class Link { } // if a plugin created the URL, return it - if ($created) { + if ($created) + { return $url; } @@ -173,8 +190,9 @@ class Link { return Link::addLinkParams($url, (isset($params['extra'])? $params['extra'] : null)); } - - function addLinkParams($link, $params) { + + static private function add_link_params($link, $params) + { global $CONF; if (is_array($params) ) { @@ -228,14 +246,16 @@ class Link { } /** + * Link::create_blog_link() * Create an link to a blog * * This function considers the URLMode of the blog * + * @static * @param $url url * @param $params parameters */ - function createBlogLink($url, $params) { + static public function create_blog_link($url, $params) { global $CONF; if ($CONF['URLMode'] == 'normal') { if (i18n::strpos($url, '?') === FALSE && is_array($params)) { @@ -251,4 +271,3 @@ class Link { } } -?> \ No newline at end of file diff --git a/nucleus/libs/globalfunctions.php b/nucleus/libs/globalfunctions.php index 304b10d..a3123a5 100644 --- a/nucleus/libs/globalfunctions.php +++ b/nucleus/libs/globalfunctions.php @@ -2272,34 +2272,42 @@ function formatDate($format, $timestamp, $default_format, &$blog) * Deprecated since 4.0: * Please use Link::FunctionName(...) instead */ -function createItemLink($itemid, $extra = '') { - return Link::createItemLink($itemid, $extra); +function createItemLink($itemid, $extra = '') +{ + return Link::create_item_link($itemid, $extra); } -function createMemberLink($memberid, $extra = '') { - return Link::createMemberLink($memberid, $extra); +function createMemberLink($memberid, $extra = '') +{ + return Link::create_member_link($memberid, $extra); } -function createCategoryLink($catid, $extra = '') { - return Link::createCategoryLink($catid, $extra); +function createCategoryLink($catid, $extra = '') +{ + return Link::create_category_link($catid, $extra); } -function createArchiveListLink($blogid = '', $extra = '') { - return Link::createArchiveListLink($blogid, $extra); +function createArchiveListLink($blogid = '', $extra = '') +{ + return Link::create_archivelist_link($blogid, $extra); } -function createArchiveLink($blogid, $archive, $extra = '') { - return Link::createArchiveLink($blogid, $archive, $extra); +function createArchiveLink($blogid, $archive, $extra = '') +{ + return Link::create_archive_link($blogid, $archive, $extra); } -function createBlogidLink($blogid, $params = '') { - return Link::createBlogidLink($blogid, $params = ''); +function createBlogidLink($blogid, $params = '') +{ + return Link::create_blogid_link($blogid, $params = ''); } -function createLink($type, $params) { - return Link::createLink($type, $params); +function createLink($type, $params) +{ + return Link::create_link($type, $params); } -function createBlogLink($url, $params) { - return Link::createBlogLink($url, $params); -} \ No newline at end of file +function createBlogLink($url, $params) +{ + return Link::create_blog_link($url, $params); +} -- 2.11.0