OSDN Git Service

CHANGE: Linkクラスを参照せずにglobalfunctions.phpのラッパー関数を参照しているスクリプトを修正。
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>
Wed, 22 Feb 2012 10:46:32 +0000 (19:46 +0900)
committerTakashi Sakamoto <o-takashi@sakamocchi.jp>
Wed, 22 Feb 2012 10:46:32 +0000 (19:46 +0900)
合わせて、Linkクラスのメソッドをコードフォーマットに従って名前変更。PHP docも修正・加筆。

nucleus/documentation/devdocs/plugins.html
nucleus/documentation/help.html
nucleus/libs/ACTION.php
nucleus/libs/ACTIONS.php
nucleus/libs/BLOG.php
nucleus/libs/COMMENTACTIONS.php
nucleus/libs/COMMENTS.php
nucleus/libs/ITEMACTIONS.php
nucleus/libs/Link.php
nucleus/libs/globalfunctions.php

index c299b6d..0abaf3a 100644 (file)
@@ -2230,7 +2230,7 @@ Make the init method in the plugin like below
          include_once($this->getDirectory().'english.php');
    }</code></pre>
 </li>
-This logic is same as Nucleus\92 language file setting.
+This logic is same as Nucleus' language file setting.
        <li><strong>Add language files</strong>
 
 As English is the default language, it is recommended to have at least the English version.    </li>
@@ -2336,7 +2336,7 @@ and global variables described below:</p>
                <td>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/"</td>
        </tr>
        <tr>
-               <td><code>createItemLink($itemid, $extra = '')</code></td>
+               <td><code>Link::create_item_link($itemid, $extra = '')</code></td>
                <td>Global function</td>
                <td><code>$itemid</code> Integer. ID of item being linked.<br />
                        <code>$extra</code> 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:</p>
                <td>Returns the full URL, in scheme chosen by user, of item indicated by <code>$itemid</code></td>
        </tr>
        <tr>
-               <td><code>createMemberLink($memberid, $extra = '')</code></td>
+               <td><code>Link::create_member_link($memberid, $extra = '')</code></td>
                <td>Global function</td>
                <td><code>$memberid</code> Integer. ID of member being linked.<br />
                        <code>$extra</code> 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:</p>
                <td>Returns the full URL, in scheme chosen by user, of member page indicated by <code>$memberid</code></td>
        </tr>
        <tr>
-               <td><code>createCategoryLink($catid, $extra = '')</code></td>
+               <td><code>Link::create_category_link($catid, $extra = '')</code></td>
                <td>Global function</td>
                <td><code>$catid</code> Integer. ID of category being linked.<br />
                        <code>$extra</code> 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:</p>
                <td>Returns the full URL, in scheme chosen by user, of category index page indicated by <code>$catid</code></td>
        </tr>
        <tr>
-               <td><code>createArchiveListLink($blogid = '', $extra = '')</code></td>
+               <td><code>create_archivelist_link($blogid = '', $extra = '')</code></td>
                <td>Global function</td>
                <td><code>$blogid</code> Integer. ID of blog whose archivelist is being linked.<br />
                        <code>$extra</code> 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:</p>
                <td>Returns the full URL, in scheme chosen by user, of archivelist page indicated by <code>$blogid</code></td>
        </tr>
        <tr>
-               <td><code>createArchiveLink($blogid, $archive, $extra = '')</code></td>
+               <td><code>create_archive_link($blogid, $archive, $extra = '')</code></td>
                <td>Global function</td>
                <td><code>$blogid</code> Integer. ID of blog whose archive is being linked.<br />
                        <code>$archive</code> String. Valid archive parameter for date (year-month) being linked.<br />
@@ -2377,7 +2377,7 @@ and global variables described below:</p>
                <td>Returns the full URL, in scheme chosen by user, of archive page indicated by <code>$blogid</code> and <code>$archive</code></td>
        </tr>
        <tr>
-               <td><code>createBlogidLink($blogid, $extra = '')</code></td>
+               <td><code>create_blogid_link($blogid, $extra = '')</code></td>
                <td>Global function</td>
                <td><code>$blogid</code> Integer. ID of blog being linked.<br />
                        <code>$extra</code> Associative Array. Containing key-value pairs corresponding to additional parameters-values that should appear in the link.
index 5c18c0a..1a3ebcd 100644 (file)
@@ -657,7 +657,7 @@ bloglist footer</pre>
        <th>Description</th>
 </tr><tr>
        <td>bloglink</td>
-       <td>URL of the blog (as generated by createBlogIdLink() function)</td>
+       <td>URL of the blog (as generated by Link::create_blogid_link() function)</td>
 </tr><tr>
        <td>blogurl</td>
        <td>URL of the blog (as defined in blogsettings)</td>
index 5809bbd..065d321 100644 (file)
@@ -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'] )
index 4a57b0f..ec276af 100644 (file)
@@ -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);
        }
index 1d6da8d..cc1fc7a 100644 (file)
@@ -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'];
 
index 6e0064a..7c21b4a 100644 (file)
@@ -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,
index e3db729..8f73266 100644 (file)
@@ -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
                        {
index 87dfc29..1d2bb07 100644 (file)
@@ -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
+?>
index 98254cb..c1e8882 100644 (file)
  * This class is a collections of functions that produce links\r
  * \r
  * All functions in this clss should only be called statically,\r
- * for example: Link::createItemLink(...)\r
+ * for example: Link::create_item_link(...)\r
  * \r
  * @license http://nucleuscms.org/license.txt GNU General Public License\r
  * @copyright Copyright (C) 2002-2011 The Nucleus Group\r
  * @version $Id: $\r
  */\r
-class Link {\r
+class Link\r
+{\r
 \r
        /**\r
+        * Link::create_item_link()\r
         * Create a link to an item\r
+        * @static\r
         * @param $itemid       item id\r
         * @param $extra        extra parameter\r
         */\r
-       function createItemLink($itemid, $extra = '') {\r
-               return Link::createLink('item', array('itemid' => $itemid, 'extra' => $extra) );\r
+       static public function create_item_link($itemid, $extra = '') {\r
+               return self::create_link('item', array('itemid' => $itemid, 'extra' => $extra) );\r
        }\r
 \r
        /**\r
+        * Link::create_member_link()\r
         * Create a link to a member\r
         * \r
+        * @static\r
         * @param $memberid     member id\r
         * @param $extra        extra parameter\r
         */\r
-       function createMemberLink($memberid, $extra = '') {\r
-               return Link::createLink('member', array('memberid' => $memberid, 'extra' => $extra) );\r
+       static public function create_member_link($memberid, $extra = '') {\r
+               return self::create_link('member', array('memberid' => $memberid, 'extra' => $extra) );\r
        }\r
        \r
        /**\r
+        * Link::create_category_link()\r
         * Create a link to a category\r
         * \r
+        * @static\r
         * @param $catid        category id\r
         * @param $extra        extra parameter\r
         */\r
-       function createCategoryLink($catid, $extra = '') {\r
-               return Link::createLink('category', array('catid' => $catid, 'extra' => $extra) );\r
+       static public function create_category_link($catid, $extra = '') {\r
+               return self::create_link('category', array('catid' => $catid, 'extra' => $extra) );\r
        }\r
 \r
        /**\r
+        * Link::cteate_archive_link()\r
         * Create a link to an archive\r
         * \r
+        * @static\r
         * @param $blogid       blog id\r
         * @param $archive      archive identifier\r
         * @param $extra        extra parameter\r
         */\r
-       function createArchiveLink($blogid, $archive, $extra = '') {\r
-               return Link::createLink('archive', array('blogid' => $blogid, 'archive' => $archive, 'extra' => $extra) );\r
+       static public function create_archive_link($blogid, $archive, $extra = '') {\r
+               return self::create_link('archive', array('blogid' => $blogid, 'archive' => $archive, 'extra' => $extra) );\r
        }\r
 \r
        /**\r
+        * Link::create_archivelist_link()\r
         * Create a link to an archive list\r
         * \r
+        * @static\r
         * @param $blogid       blog id\r
         * @param $extra        extra parameter\r
         */\r
-       function createArchiveListLink($blogid = '', $extra = '') {\r
-               return Link::createLink('archivelist', array('blogid' => $blogid, 'extra' => $extra) );\r
+       static public function create_archivelist_link($blogid = '', $extra = '') {\r
+               return self::create_link('archivelist', array('blogid' => $blogid, 'extra' => $extra) );\r
        }\r
 \r
        /**\r
+        * Link::create_blogid_link()\r
         * Create a link to a blog\r
         * \r
+        * @static\r
         * @param $blogid       blog id\r
         * @param $extra        extra parameter\r
         */\r
-       function createBlogidLink($blogid, $params = '') {\r
-               return Link::createLink('blog', array('blogid' => $blogid, 'extra' => $params) );\r
+       static public function create_blogid_link($blogid, $params = '') {\r
+               return self::create_link('blog', array('blogid' => $blogid, 'extra' => $params) );\r
        }\r
 \r
        /**\r
+        * Link::create_link()\r
         * Create a link\r
         * \r
         * Universell function that creates link of different types (like item, blog ...)\r
         * and with an array of parameters\r
         * \r
+        * @static\r
         * @param $type         type of the link\r
         * @param $params       array with parameters\r
         */\r
-       function createLink($type, $params) {\r
+       static public function create_link($type, $params) {\r
                global $manager, $CONF;\r
        \r
                $generatedURL = '';\r
@@ -99,7 +114,8 @@ class Link {
                // ask plugins first\r
                $created = false;\r
        \r
-               if ($usePathInfo) {\r
+               if ($usePathInfo)\r
+               {\r
                        $manager->notify(\r
                                'GenerateURL',\r
                                array(\r
@@ -112,7 +128,8 @@ class Link {
                }\r
        \r
                // if a plugin created the URL, return it\r
-               if ($created) {\r
+               if ($created)\r
+               {\r
                        return $url;\r
                }\r
        \r
@@ -173,8 +190,9 @@ class Link {
        \r
                return Link::addLinkParams($url, (isset($params['extra'])? $params['extra'] : null));\r
        }\r
-\r
-       function addLinkParams($link, $params) {\r
+       \r
+       static private function add_link_params($link, $params)\r
+       {\r
                global $CONF;\r
        \r
                if (is_array($params) ) {\r
@@ -228,14 +246,16 @@ class Link {
        }\r
 \r
        /**\r
+        * Link::create_blog_link()\r
         * Create an link to a blog\r
         * \r
         * This function considers the URLMode of the blog\r
         * \r
+        * @static\r
         * @param $url          url\r
         * @param $params       parameters\r
         */\r
-       function createBlogLink($url, $params) {\r
+       static public function create_blog_link($url, $params) {\r
                global $CONF;\r
                if ($CONF['URLMode'] == 'normal') {\r
                        if (i18n::strpos($url, '?') === FALSE && is_array($params)) {\r
@@ -251,4 +271,3 @@ class Link {
        }\r
 \r
 }\r
-?>
\ No newline at end of file
index 304b10d..a3123a5 100644 (file)
@@ -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);
+}