michaeluno / admin-page-framework

development/factory/admin_page/AdminPageFramework_Controller_Menu.php

Indentation +60 added lines, -60 removed lines

@@ -173,52 +173,52 @@ 
     }
     
     /**
-    * Adds the given sub-menu item on the left sidebar menu of the administration panel.
-    * 
-    * It supports pages and links. Each of them has the specific array structure.
-    * 
-    * <h4>Example</h4>
-    * <code>
-    * $this->addSubMenuItem(
-    *       array(
-    *           'title'         => 'Read Me',
-    *           'menu_title'    => 'About'
-    *           'page_slug'     => 'my_plugin_readme',
-    *       )
-    * );
-    * </code>
-    * 
-    * @since        2.0.0
-    * @since        3.0.0       Changed the scope to public.
-    * @remark       The sub menu page slug should be unique because add_submenu_page() can add one callback per page slug.
-    * @param        array       a sub-menu array. It can be a page or a link. The array structures are as follows:
-    * <h4>Sub-menu Page Array</h4>
-    * <ul>
-    *   <li>**title** - (string) the page title of the page.</li>
-    *   <li>**page_slug** - (string) the page slug of the page. Non-alphabetical characters should not be used including dots(.) and hyphens(-).</li>
-    *   <li>**screen_icon** - (optional, string) either the ID selector name from the following list or the icon URL. The size of the icon should be 32 by 32 in pixel. This is for WordPress 3.7.x or below.
-    *       <pre>edit, post, index, media, upload, link-manager, link, link-category, edit-pages, page, edit-comments, themes, plugins, users, profile, user-edit, tools, admin, options-general, ms-admin, generic</pre>
-    *       <p>( Notes: the `generic` icon is available WordPress version 3.5 or above.)</p> 
-    *   </li>
-    *   <li>**capability** - (optional, string) the access level to the created admin pages defined <a href="http://codex.wordpress.org/Roles_and_Capabilities">here</a>. If not set, the overall capability assigned in the class constructor, which is `manage_options` by default, will be used.</li>
-    *   <li>**order** - (optional, integer) the order number of the page. The lager the number is, the lower the position it is placed in the menu.</li>
-    *   <li>**show_page_heading_tab** - (optional, boolean) if this is set to false, the page title won't be displayed in the page heading tab. Default: `true`.</li>
-    *   <li>**show_in_menu** - (optional) If this is set to false, the page title won't be displayed in the sidebar menu while the page is still accessible. Default: true.</li>
-    *   <li>**page_title** - (optional) [3.3.0+] When the page title differs from the menu title, use this argument.</li>
-    *   <li>**menu_title** - (optional) [3.3.0+] When the menu title differs from the menu title, use this argument.</li>
-    * </ul>
-    * <h4>Sub-menu Link Array</h4>
-    * <ul>
-    *   <li>**title** - (string) the link title.</li>
-    *   <li>**href** - (string) the URL of the target link.</li>
-    *   <li>**capability** - (optional, string) the access level to show the item, defined <a href="http://codex.wordpress.org/Roles_and_Capabilities">here</a>. If not set, the overall capability assigned in the class constructor, which is `manage_options` by default, will be used.</li>
-    *   <li>**order** - (optional, integer) the order number of the page. The lager the number is, the lower the position it is placed in the menu.</li>
-    *   <li>**show_page_heading_tab** - (optional, boolean) if this is set to false, the page title won't be displayed in the page heading tab. Default: `true`.</li>
-    *   <li>**show_in_menu** - (optional) If this is set to false, the page title won't be displayed in the sidebar menu while the page is still accessible. Default: true.</li>
-    * </ul>
-    * @access       public
-    * @return       void
-    */    
+     * Adds the given sub-menu item on the left sidebar menu of the administration panel.
+     * 
+     * It supports pages and links. Each of them has the specific array structure.
+     * 
+     * <h4>Example</h4>
+     * <code>
+     * $this->addSubMenuItem(
+     *       array(
+     *           'title'         => 'Read Me',
+     *           'menu_title'    => 'About'
+     *           'page_slug'     => 'my_plugin_readme',
+     *       )
+     * );
+     * </code>
+     * 
+     * @since        2.0.0
+     * @since        3.0.0       Changed the scope to public.
+     * @remark       The sub menu page slug should be unique because add_submenu_page() can add one callback per page slug.
+     * @param        array       a sub-menu array. It can be a page or a link. The array structures are as follows:
+     * <h4>Sub-menu Page Array</h4>
+     * <ul>
+     *   <li>**title** - (string) the page title of the page.</li>
+     *   <li>**page_slug** - (string) the page slug of the page. Non-alphabetical characters should not be used including dots(.) and hyphens(-).</li>
+     *   <li>**screen_icon** - (optional, string) either the ID selector name from the following list or the icon URL. The size of the icon should be 32 by 32 in pixel. This is for WordPress 3.7.x or below.
+     *       <pre>edit, post, index, media, upload, link-manager, link, link-category, edit-pages, page, edit-comments, themes, plugins, users, profile, user-edit, tools, admin, options-general, ms-admin, generic</pre>
+     *       <p>( Notes: the `generic` icon is available WordPress version 3.5 or above.)</p> 
+     *   </li>
+     *   <li>**capability** - (optional, string) the access level to the created admin pages defined <a href="http://codex.wordpress.org/Roles_and_Capabilities">here</a>. If not set, the overall capability assigned in the class constructor, which is `manage_options` by default, will be used.</li>
+     *   <li>**order** - (optional, integer) the order number of the page. The lager the number is, the lower the position it is placed in the menu.</li>
+     *   <li>**show_page_heading_tab** - (optional, boolean) if this is set to false, the page title won't be displayed in the page heading tab. Default: `true`.</li>
+     *   <li>**show_in_menu** - (optional) If this is set to false, the page title won't be displayed in the sidebar menu while the page is still accessible. Default: true.</li>
+     *   <li>**page_title** - (optional) [3.3.0+] When the page title differs from the menu title, use this argument.</li>
+     *   <li>**menu_title** - (optional) [3.3.0+] When the menu title differs from the menu title, use this argument.</li>
+     * </ul>
+     * <h4>Sub-menu Link Array</h4>
+     * <ul>
+     *   <li>**title** - (string) the link title.</li>
+     *   <li>**href** - (string) the URL of the target link.</li>
+     *   <li>**capability** - (optional, string) the access level to show the item, defined <a href="http://codex.wordpress.org/Roles_and_Capabilities">here</a>. If not set, the overall capability assigned in the class constructor, which is `manage_options` by default, will be used.</li>
+     *   <li>**order** - (optional, integer) the order number of the page. The lager the number is, the lower the position it is placed in the menu.</li>
+     *   <li>**show_page_heading_tab** - (optional, boolean) if this is set to false, the page title won't be displayed in the page heading tab. Default: `true`.</li>
+     *   <li>**show_in_menu** - (optional) If this is set to false, the page title won't be displayed in the sidebar menu while the page is still accessible. Default: true.</li>
+     * </ul>
+     * @access       public
+     * @return       void
+     */    
     public function addSubMenuItem( array $aSubMenuItem ) {
         if ( isset( $aSubMenuItem[ 'href' ] ) ) {
             $this->addSubMenuLink( $aSubMenuItem );
@@ -228,20 +228,20 @@ 
     }
 
     /**
-    * Adds the given link into the menu on the left sidebar of the administration panel.
-    * 
-    * @since        2.0.0
-    * @since        3.0.0       Changed the scope to public from protected.
-    * @since        3.5.0       Changed the scope to public as it was still protected.
-    * @param        string      the menu title.
-    * @param        string      the URL linked to the menu.
-    * @param        string      (optional) the <a href="http://codex.wordpress.org/Roles_and_Capabilities" target="_blank">access level</a>.
-    * @param        string      (optional) the order number. The larger it is, the lower the position it gets.
-    * @param        string      (optional) if set to false, the menu title will not be listed in the tab navigation menu at the top of the page.
-    * @access       public
-    * @return       void
-    * @internal
-    */    
+     * Adds the given link into the menu on the left sidebar of the administration panel.
+     * 
+     * @since        2.0.0
+     * @since        3.0.0       Changed the scope to public from protected.
+     * @since        3.5.0       Changed the scope to public as it was still protected.
+     * @param        string      the menu title.
+     * @param        string      the URL linked to the menu.
+     * @param        string      (optional) the <a href="http://codex.wordpress.org/Roles_and_Capabilities" target="_blank">access level</a>.
+     * @param        string      (optional) the order number. The larger it is, the lower the position it gets.
+     * @param        string      (optional) if set to false, the menu title will not be listed in the tab navigation menu at the top of the page.
+     * @access       public
+     * @return       void
+     * @internal
+     */    
     public function addSubMenuLink( array $aSubMenuLink ) {
         
         // If required keys are not set, return.