michaeluno / admin-page-framework

development/factory/admin_page/AdminPageFramework_Controller.php

Indentation +35 added lines, -35 removed lines

@@ -219,24 +219,24 @@ 
     }
     
     /**
-    * Adds the given link(s) into the description cell of the plugin listing table.
-    * 
-    * <h4>Example</h4>
-    * <code>$this->addLinkToPluginDescription( 
-    *       "<a href='http://www.google.com'>Google</a>",
-    *       "<a href='http://www.yahoo.com'>Yahoo!</a>"
-    * );</code>
-    * 
-    * @since        2.0.0
-    * @since        3.0.0       Changed the scope to public from protected.
-    * @since        3.3.1       Moved from `AdminPageFramework`.
-    * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-    * @param        string      the tagged HTML link text.
-    * @param        string      (optional) another tagged HTML link text.
-    * @param        string      (optional) add more as many as want by adding items to the next parameters.
-    * @access       public
-    * @return       void
-    */     
+     * Adds the given link(s) into the description cell of the plugin listing table.
+     * 
+     * <h4>Example</h4>
+     * <code>$this->addLinkToPluginDescription( 
+     *       "<a href='http://www.google.com'>Google</a>",
+     *       "<a href='http://www.yahoo.com'>Yahoo!</a>"
+     * );</code>
+     * 
+     * @since        2.0.0
+     * @since        3.0.0       Changed the scope to public from protected.
+     * @since        3.3.1       Moved from `AdminPageFramework`.
+     * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
+     * @param        string      the tagged HTML link text.
+     * @param        string      (optional) another tagged HTML link text.
+     * @param        string      (optional) add more as many as want by adding items to the next parameters.
+     * @access       public
+     * @return       void
+     */     
     public function addLinkToPluginDescription( $sTaggedLinkHTML1, $sTaggedLinkHTML2=null, $_and_more=null ) {
         if ( method_exists( $this->oLink, '_addLinkToPluginDescription' ) ) {
             $this->oLink->_addLinkToPluginDescription( func_get_args() );     
@@ -244,23 +244,23 @@ 
     }
 
     /**
-    * Adds the given link(s) into the title cell of the plugin listing table.
-    * 
-    * <h4>Example</h4>
-    * <code>$this->addLinkToPluginTitle( 
-    *       "<a href='http://www.wordpress.org'>WordPress</a>"
-    * );</code>
-    * 
-    * @since        2.0.0
-    * @since        3.0.0       Changed the scope to public from protected.
-    * @since        3.3.1       Moved from `AdminPageFramework`.
-    * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-    * @param        string      the tagged HTML link text.
-    * @param        string      (optional) another tagged HTML link text.
-    * @param        string      (optional) add more as many as want by adding items to the next parameters.
-    * @access       public
-    * @return       void
-    */    
+     * Adds the given link(s) into the title cell of the plugin listing table.
+     * 
+     * <h4>Example</h4>
+     * <code>$this->addLinkToPluginTitle( 
+     *       "<a href='http://www.wordpress.org'>WordPress</a>"
+     * );</code>
+     * 
+     * @since        2.0.0
+     * @since        3.0.0       Changed the scope to public from protected.
+     * @since        3.3.1       Moved from `AdminPageFramework`.
+     * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
+     * @param        string      the tagged HTML link text.
+     * @param        string      (optional) another tagged HTML link text.
+     * @param        string      (optional) add more as many as want by adding items to the next parameters.
+     * @access       public
+     * @return       void
+     */    
     public function addLinkToPluginTitle( $sTaggedLinkHTML1, $sTaggedLinkHTML2=null, $_and_more=null ) {    
         if ( method_exists( $this->oLink, '_addLinkToPluginTitle' ) ) {
             $this->oLink->_addLinkToPluginTitle( func_get_args() );     

development/factory/admin_page/AdminPageFramework_Controller_Form.php

Indentation +45 added lines, -45 removed lines

@@ -140,24 +140,24 @@ 
     }
     
     /**
-    * Removes the given section(s) by section ID.
-    * 
-    * This accesses the property storing the added section arrays and removes the specified ones.
-    * 
-    * <h4>Example</h4>
-    * <code>$this->removeSettingSections( 'text_fields', 'selectors', 'another_section', 'yet_another_section' );
-    * </code>
-    * 
-    * @since        2.0.0
-    * @since        3.0.0       Changed the scope to public from protected.
-    * @since        3.5.3       Removed the parameter declarations as they are caught with the func_get_args().
-    * @access       public
-    * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-    * @param        string      $sSectionID1        the section ID to remove.
-    * @param        string      $sSectionID2        (optional) another section ID to remove.
-    * @param        string      $_and_more          (optional) add more section IDs to the next parameters as many as necessary.
-    * @return       void
-    */    
+     * Removes the given section(s) by section ID.
+     * 
+     * This accesses the property storing the added section arrays and removes the specified ones.
+     * 
+     * <h4>Example</h4>
+     * <code>$this->removeSettingSections( 'text_fields', 'selectors', 'another_section', 'yet_another_section' );
+     * </code>
+     * 
+     * @since        2.0.0
+     * @since        3.0.0       Changed the scope to public from protected.
+     * @since        3.5.3       Removed the parameter declarations as they are caught with the func_get_args().
+     * @access       public
+     * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
+     * @param        string      $sSectionID1        the section ID to remove.
+     * @param        string      $sSectionID2        (optional) another section ID to remove.
+     * @param        string      $_and_more          (optional) add more section IDs to the next parameters as many as necessary.
+     * @return       void
+     */    
     public function removeSettingSections( /* $sSectionID1=null, $sSectionID2=null, $_and_more=null */ ) {    
         
         foreach( func_get_args() as $_sSectionID ) {
@@ -224,38 +224,38 @@ 
         }
     }
     /**
-    * Adds the given field array items into the field array property.
-    * 
-    * Identical to the `addSettingFields()` method except that this method does not accept enumerated parameters. 
-    * 
-    * @since        2.1.2
-    * @since        3.0.0           Changed the scope to public from protected.
-    * @access       public
-    * @param        array|string    $asField        the field array or the target section ID. If the target section ID is set, the section_id key can be omitted from the next passing field array.
-    * @return       void
-    */    
+     * Adds the given field array items into the field array property.
+     * 
+     * Identical to the `addSettingFields()` method except that this method does not accept enumerated parameters. 
+     * 
+     * @since        2.1.2
+     * @since        3.0.0           Changed the scope to public from protected.
+     * @access       public
+     * @param        array|string    $asField        the field array or the target section ID. If the target section ID is set, the section_id key can be omitted from the next passing field array.
+     * @return       void
+     */    
     public function addSettingField( $asField ) {
         $this->oForm->addField( $asField );    
     }    
     
     /**
-    * Removes the given field(s) by field ID.
-    * 
-    * This accesses the property storing the added field arrays and removes the specified ones.
-    * 
-    * <h4>Example</h4>
-    * <code>$this->removeSettingFields( 'fieldID_A', 'fieldID_B', 'fieldID_C', 'fieldID_D' );
-    * </code>
-    * 
-    * @since        2.0.0
-    * @since        3.0.0       Changed the scope to public from protected.
-    * @access       public
-    * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-    * @param        string      $sFieldID1      the field ID to remove.
-    * @param        string      $sFieldID2      (optional) another field ID to remove.
-    * @param        string      $_and_more      (optional) add more field IDs to the next parameters as many as necessary.
-    * @return void
-    */    
+     * Removes the given field(s) by field ID.
+     * 
+     * This accesses the property storing the added field arrays and removes the specified ones.
+     * 
+     * <h4>Example</h4>
+     * <code>$this->removeSettingFields( 'fieldID_A', 'fieldID_B', 'fieldID_C', 'fieldID_D' );
+     * </code>
+     * 
+     * @since        2.0.0
+     * @since        3.0.0       Changed the scope to public from protected.
+     * @access       public
+     * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
+     * @param        string      $sFieldID1      the field ID to remove.
+     * @param        string      $sFieldID2      (optional) another field ID to remove.
+     * @param        string      $_and_more      (optional) add more field IDs to the next parameters as many as necessary.
+     * @return void
+     */    
     public function removeSettingFields( $sFieldID1, $sFieldID2=null, $_and_more ) {
         foreach( func_get_args() as $_sFieldID ) { 
             $this->oForm->removeField( $_sFieldID ); 

development/factory/admin_page/AdminPageFramework_Controller_Menu.php

Indentation +91 added lines, -91 removed lines

@@ -104,39 +104,39 @@ 
     }
     
     /**
-    * Adds sub-menu items 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->addSubMenuItems(
-    *       array(
-    *           'title'         => 'Various Form Fields',
-    *           'page_slug'     => 'first_page',
-    *           'screen_icon'   => 'options-general',
-    *       ),
-    *       array(
-    *           'title'         => 'Manage Options',
-    *           'page_slug'     => 'second_page',
-    *           'screen_icon'   => 'link-manager',
-    *       ),
-    *       array(
-    *           'title'         => 'Google',
-    *           'href'          => 'http://www.google.com',    
-    *           'show_page_heading_tab' => false, // this removes the title from the page heading tabs.
-    *       )
-    * );</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.
-    * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-    * @param        array       $aSubMenuItem1      a first sub-menu array. A sub-menu array can be a link or a page. For the specifications of the array structures and its arguments, refer to the parameter section of the `addSubMenuItem()` method.
-    * @param        array       $aSubMenuItem2      (optional) a second sub-menu array.
-    * @param        array       $_and_more          (optional) a third and add items as many as necessary with next parameters.
-    * @access       public
-    * @return       void
-    */     
+     * Adds sub-menu items 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->addSubMenuItems(
+     *       array(
+     *           'title'         => 'Various Form Fields',
+     *           'page_slug'     => 'first_page',
+     *           'screen_icon'   => 'options-general',
+     *       ),
+     *       array(
+     *           'title'         => 'Manage Options',
+     *           'page_slug'     => 'second_page',
+     *           'screen_icon'   => 'link-manager',
+     *       ),
+     *       array(
+     *           'title'         => 'Google',
+     *           'href'          => 'http://www.google.com',    
+     *           'show_page_heading_tab' => false, // this removes the title from the page heading tabs.
+     *       )
+     * );</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.
+     * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
+     * @param        array       $aSubMenuItem1      a first sub-menu array. A sub-menu array can be a link or a page. For the specifications of the array structures and its arguments, refer to the parameter section of the `addSubMenuItem()` method.
+     * @param        array       $aSubMenuItem2      (optional) a second sub-menu array.
+     * @param        array       $_and_more          (optional) a third and add items as many as necessary with next parameters.
+     * @access       public
+     * @return       void
+     */     
     public function addSubMenuItems( $aSubMenuItem1, $aSubMenuItem2=null, $_and_more=null ) {
         foreach ( func_get_args() as $_aSubMenuItem ) {
             $this->addSubMenuItem( $_aSubMenuItem );     
@@ -144,50 +144,50 @@ 
     }
     
     /**
-    * 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 );
@@ -197,20 +197,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.

development/factory/admin_page/_model/format/AdminPageFramework_Format_InPageTabs.php

Indentation +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
      */
     public function get() {
 
-         // Apply filters to modify the in-page tab array.
+            // Apply filters to modify the in-page tab array.
         $_aInPageTabs = $this->addAndApplyFilter(
             $this->oFactory,  // caller object
             "tabs_{$this->oFactory->oProp->sClassName}_{$this->sPageSlug}", // filter name

development/factory/admin_page/_model/format/AdminPageFramework_Format_SubMenuItem.php

Indentation -1 removed lines

@@ -19,7 +19,6 @@
     
     /**
      * Represents the structure of the sub-field definition array.
-  
      */
     static public $aStructure = array(
     );

development/factory/admin_page/_view/AdminPageFramework_View__PageMataBoxRenderer.php

Indentation -1 removed lines

@@ -20,7 +20,6 @@
            
     /**
      * Renders a registered meta box.
- 
      * @return      void
      * @param       string $sContext `side`, `normal`, or `advanced`.
      * @since       3.0.0

development/factory/meta_box/AdminPageFramework_MetaBox_Controller.php

Indentation +26 added lines, -26 removed lines

@@ -18,32 +18,32 @@
 abstract class AdminPageFramework_MetaBox_Controller extends AdminPageFramework_MetaBox_View {
        
     /**
-    * The method for all necessary set-ups.
-    * 
-    * <h4>Example</h4>
-    * <code> public function setUp() {     
-    *     $this->addSettingFields(
-    *         array(
-    *             'field_id'    => 'sample_metabox_text_field',
-    *             'title'       => 'Text Input',
-    *             'description' => 'The description for the field.',
-    *             'type'        => 'text',
-    *         ),
-    *         array(
-    *             'field_id'    => 'sample_metabox_textarea_field',
-    *             'title'       => 'Textarea',
-    *             'description' => 'The description for the field.',
-    *             'type'        => 'textarea',
-    *             'default'     => 'This is a default text value.',
-    *         )
-    *     );     
-    * }</code>
-    * 
-    * @abstract
-    * @since        2.0.0
-    * @remark       The user should override this method.
-    * @return       void
-    */  
+     * The method for all necessary set-ups.
+     * 
+     * <h4>Example</h4>
+     * <code> public function setUp() {     
+     *     $this->addSettingFields(
+     *         array(
+     *             'field_id'    => 'sample_metabox_text_field',
+     *             'title'       => 'Text Input',
+     *             'description' => 'The description for the field.',
+     *             'type'        => 'text',
+     *         ),
+     *         array(
+     *             'field_id'    => 'sample_metabox_textarea_field',
+     *             'title'       => 'Textarea',
+     *             'description' => 'The description for the field.',
+     *             'type'        => 'textarea',
+     *             'default'     => 'This is a default text value.',
+     *         )
+     *     );     
+     * }</code>
+     * 
+     * @abstract
+     * @since        2.0.0
+     * @remark       The user should override this method.
+     * @return       void
+     */  
     public function setUp() {}    
 
     /**

development/factory/meta_box/AdminPageFramework_MetaBox_Model.php

Indentation +2 added lines, -2 removed lines

@@ -136,11 +136,11 @@
      * 
      * Triggered when a post has not been created so no post id is assigned.
      * 
-	 * @internal
+     * @internal
      * @since       3.3.0
      * @callback    filter      wp_insert_attachment_data
      * @callback    filter      wp_insert_post_data
-	 * @param       array       $aPostData      An array of slashed post data.
+     * @param       array       $aPostData      An array of slashed post data.
      * @param       array       $aUnmodified    An array of sanitized, but otherwise unmodified post data.
      */
     public function _replyToFilterSavingData( $aPostData, $aUnmodified ) {

development/factory/page_meta_box/AdminPageFramework_PageMetaBox_Model.php

Indentation +1 added lines, -1 removed lines

@@ -277,7 +277,7 @@
         );        
     }    
     
-       /**
+        /**
          * Extracts meta box form fields options array from the given options array of an admin page.
          * 
          * @since       3.5.6