michaeluno / admin-page-framework

development/factory/admin_page/AdminPageFramework.php

Doc Comments +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
      * @since       2.0.0
      * @see         http://codex.wordpress.org/Roles_and_Capabilities
      * @see         http://codex.wordpress.org/I18n_for_WordPress_Developers#Text_Domains
-     * @param       array|integer|string    $aisOptionKey    (optional) specifies the option key name to store in the options table. If this is not set, the instantiated class name will be used as default. 
+     * @param       array|integer|string    $isOptionKey    (optional) specifies the option key name to store in the options table. If this is not set, the instantiated class name will be used as default. 
      * [3.5.9+] If an integer is given, a transient will be used. If an array of option key arguments is given, the argument values will be set to the framework properties.
      * - type - either `options_table` or `transient`.
      * - key - the option key or the transient key

Spacing +5 added lines, -5 removed lines

@@ -56,9 +56,9 @@ 
      * @param       string                  $sCapability    (optional) sets the overall access level to the admin pages created by the framework. The used capabilities are listed <a href="http://codex.wordpress.org/Roles_and_Capabilities">here</a>. The capability can be set per page, tab, setting section, setting field. Default: `manage_options`
      * @param       string                  $sTextDomain    (optional) the <a href="http://codex.wordpress.org/I18n_for_WordPress_Developers#Text_Domains" target="_blank">text domain</a> used for the framework's system messages. Default: admin-page-framework.
      */
-    public function __construct( $isOptionKey=null, $sCallerPath=null, $sCapability='manage_options', $sTextDomain='admin-page-framework' ){
+    public function __construct( $isOptionKey = null, $sCallerPath = null, $sCapability = 'manage_options', $sTextDomain = 'admin-page-framework' ) {
                         
-        if ( ! $this->_isInstantiatable() ) {
+        if ( !$this->_isInstantiatable() ) {
             return;
         }
                         
@@ -66,15 +66,15 @@ 
             $isOptionKey, 
             $sCallerPath 
                 ? trim( $sCallerPath )
-                : $sCallerPath = ( is_admin() && ( isset( $GLOBALS['pagenow'] ) && in_array( $GLOBALS['pagenow'], array( 'plugins.php', ) ) || isset( $_GET['page'] ) ) 
+                : $sCallerPath = ( is_admin() && ( isset( $GLOBALS[ 'pagenow' ] ) && in_array( $GLOBALS[ 'pagenow' ], array( 'plugins.php',) ) || isset( $_GET[ 'page' ] ) ) 
                     ? AdminPageFramework_Utility::getCallerScriptPath( __FILE__ ) 
                     : null 
-                ),     // this is important to attempt to find the caller script path here when separating the library into multiple files.    
+                ), // this is important to attempt to find the caller script path here when separating the library into multiple files.    
             $sCapability, 
             $sTextDomain 
         );
         
-        $this->oUtil->addAndDoAction( $this, 'start_' . $this->oProp->sClassName, $this );
+        $this->oUtil->addAndDoAction( $this, 'start_'.$this->oProp->sClassName, $this );
 
     }    
         

Braces +1 added lines, -1 removed lines

@@ -56,7 +56,7 @@
      * @param       string                  $sCapability    (optional) sets the overall access level to the admin pages created by the framework. The used capabilities are listed <a href="http://codex.wordpress.org/Roles_and_Capabilities">here</a>. The capability can be set per page, tab, setting section, setting field. Default: `manage_options`
      * @param       string                  $sTextDomain    (optional) the <a href="http://codex.wordpress.org/I18n_for_WordPress_Developers#Text_Domains" target="_blank">text domain</a> used for the framework's system messages. Default: admin-page-framework.
      */
-    public function __construct( $isOptionKey=null, $sCallerPath=null, $sCapability='manage_options', $sTextDomain='admin-page-framework' ){
+    public function __construct( $isOptionKey=null, $sCallerPath=null, $sCapability='manage_options', $sTextDomain='admin-page-framework' ) {
                         
         if ( ! $this->_isInstantiatable() ) {
             return;

development/factory/admin_page/AdminPageFramework_Controller.php

Doc Comments +6 added lines

@@ -142,6 +142,7 @@ 
      *     <li>**media** - (optional, string) the description of the field which is inserted into the after the input field tag.</li>
      *     <li>**attributes** - (optional, array) [3.3.0+] attributes array. `array( 'data-id' => '...' )`</li>
      * </ul>
+     * @param string $sSRC
      * @return      string      The style handle ID. If the passed url is not a valid url string, an empty string will be returned.
      */    
     public function enqueueStyle( $sSRC, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {
@@ -234,6 +235,7 @@ 
     * @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.
+    * @param string $sTaggedLinkHTML1
     * @access       public
     * @return       void
     */     
@@ -258,6 +260,9 @@ 
     * @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.
+    * @param null|string $sTaggedLinkHTML1
+    * @param string $sTaggedLinkHTML2
+    * @param string $_and_more
     * @access       public
     * @return       void
     */    
@@ -274,6 +279,7 @@ 
      * 
      * @since       3.1.0
      * @since       3.3.1       Moved from `AdminPageFramework`.
+     * @param string $sLabel
      */  
     public function setPluginSettingsLinkLabel( $sLabel ) {
         $this->oProp->sLabelPluginSettingsLink = $sLabel;

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() );     

Spacing +10 added lines, -10 removed lines

@@ -107,7 +107,7 @@ 
      * @param       array       $aCustomArgs    (optional) The argument array for more advanced parameters.
      * @return      array       The array holing the queued items.
      */
-    public function enqueueStyles( $aSRCs, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {
+    public function enqueueStyles( $aSRCs, $sPageSlug = '', $sTabSlug = '', $aCustomArgs = array() ) {
         if ( method_exists( $this->oResource, '_enqueueStyles' ) ) {
             return $this->oResource->_enqueueStyles( $aSRCs, $sPageSlug, $sTabSlug, $aCustomArgs );
         }
@@ -144,7 +144,7 @@ 
      * </ul>
      * @return      string      The style handle ID. If the passed url is not a valid url string, an empty string will be returned.
      */    
-    public function enqueueStyle( $sSRC, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {
+    public function enqueueStyle( $sSRC, $sPageSlug = '', $sTabSlug = '', $aCustomArgs = array() ) {
         if ( method_exists( $this->oResource, '_enqueueStyle' ) ) {
             return $this->oResource->_enqueueStyle( $sSRC, $sPageSlug, $sTabSlug, $aCustomArgs );     
         }
@@ -171,7 +171,7 @@ 
      * @param       array       (optional) The argument array for more advanced parameters.
      * @return      array        The array holding the queued items.
      */
-    public function enqueueScripts( $aSRCs, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {
+    public function enqueueScripts( $aSRCs, $sPageSlug = '', $sTabSlug = '', $aCustomArgs = array() ) {
         if ( method_exists( $this->oResource, '_enqueueScripts' ) ) {
             return $this->oResource->_enqueueScripts( $aSRCs, $sPageSlug, $sTabSlug, $aCustomArgs );
         }
@@ -212,7 +212,7 @@ 
      * </ul>
      * @return      string      The script handle ID. If the passed url is not a valid url string, an empty string will be returned.
      */
-    public function enqueueScript( $sSRC, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {    
+    public function enqueueScript( $sSRC, $sPageSlug = '', $sTabSlug = '', $aCustomArgs = array() ) {    
         if ( method_exists( $this->oResource, '_enqueueScript' ) ) {
             return $this->oResource->_enqueueScript( $sSRC, $sPageSlug, $sTabSlug, $aCustomArgs );
         }
@@ -237,7 +237,7 @@ 
     * @access       public
     * @return       void
     */     
-    public function addLinkToPluginDescription( $sTaggedLinkHTML1, $sTaggedLinkHTML2=null, $_and_more=null ) {
+    public function addLinkToPluginDescription( $sTaggedLinkHTML1, $sTaggedLinkHTML2 = null, $_and_more = null ) {
         if ( method_exists( $this->oLink, '_addLinkToPluginDescription' ) ) {
             $this->oLink->_addLinkToPluginDescription( func_get_args() );     
         }
@@ -261,7 +261,7 @@ 
     * @access       public
     * @return       void
     */    
-    public function addLinkToPluginTitle( $sTaggedLinkHTML1, $sTaggedLinkHTML2=null, $_and_more=null ) {    
+    public function addLinkToPluginTitle( $sTaggedLinkHTML1, $sTaggedLinkHTML2 = null, $_and_more = null ) {    
         if ( method_exists( $this->oLink, '_addLinkToPluginTitle' ) ) {
             $this->oLink->_addLinkToPluginTitle( func_get_args() );     
         }
@@ -317,7 +317,7 @@ 
      * @param       string      (optional) The class selector used in the message HTML element. 'error' and 'updated' are prepared by WordPress but it's not limited to them and can pass a custom name. Default: 'error'.
      * @param       string      (optional) The ID of the message. If not set, the hash of the message will be used.
      */
-    public function setAdminNotice( $sMessage, $sClassSelector='error', $sID='' ) {
+    public function setAdminNotice( $sMessage, $sClassSelector = 'error', $sID = '' ) {
             
         $sID = $sID ? $sID : md5( $sMessage );
         
@@ -354,9 +354,9 @@ 
      * @param       boolean         If true, the passed key(s) will be appended to the property; otherwise, it will override the property.
      * @return      void
      */
-    public function setDisallowedQueryKeys( $asQueryKeys, $bAppend=true ) {
+    public function setDisallowedQueryKeys( $asQueryKeys, $bAppend = true ) {
         
-        if ( ! $bAppend ) {
+        if ( !$bAppend ) {
             $this->oProp->aDisallowedQueryKeys = ( array ) $asQueryKeys;
             return;
         }
@@ -399,7 +399,7 @@ 
      * @param       mixed       $vDefault       the default value that will be returned if nothing is stored.
      * @return      mixed       If the field ID is not specified
      */
-    static public function getOption( $sOptionKey, $asKey=null, $vDefault=null ) {
+    static public function getOption( $sOptionKey, $asKey = null, $vDefault = null ) {
         return AdminPageFramework_WPUtility::getOption( $sOptionKey, $asKey, $vDefault );
     }    
     

Braces +2 added lines, -2 removed lines

@@ -212,7 +212,7 @@ 
      * </ul>
      * @return      string      The script handle ID. If the passed url is not a valid url string, an empty string will be returned.
      */
-    public function enqueueScript( $sSRC, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {    
+    public function enqueueScript( $sSRC, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {
         if ( method_exists( $this->oResource, '_enqueueScript' ) ) {
             return $this->oResource->_enqueueScript( $sSRC, $sPageSlug, $sTabSlug, $aCustomArgs );
         }
@@ -261,7 +261,7 @@ 
     * @access       public
     * @return       void
     */    
-    public function addLinkToPluginTitle( $sTaggedLinkHTML1, $sTaggedLinkHTML2=null, $_and_more=null ) {    
+    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

Doc Comments -3 removed lines

@@ -153,9 +153,6 @@
     * @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 */ ) {    

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 ); 

Spacing +13 added lines, -13 removed lines

@@ -72,7 +72,7 @@ 
      */     
     public function addSettingSections( /* $aSection1, $aSection2=null, $_and_more=null */ ) {
         
-        foreach( func_get_args() as $asSection ) { 
+        foreach ( func_get_args() as $asSection ) { 
             $this->addSettingSection( $asSection ); 
         }
         
@@ -95,7 +95,7 @@ 
      */
     public function addSettingSection( $asSection ) {
                 
-        if ( ! is_array( $asSection ) ) {
+        if ( !is_array( $asSection ) ) {
             $this->_sTargetPageSlug = is_string( $asSection )
                 ? $asSection 
                 : $this->_sTargetPageSlug;
@@ -122,7 +122,7 @@ 
             )
         ); // avoid undefined index warnings.
         
-        $aSection[ 'page_slug' ]          = $aSection[ 'page_slug' ] 
+        $aSection[ 'page_slug' ] = $aSection[ 'page_slug' ] 
             ? $this->oUtil->sanitizeSlug( $aSection[ 'page_slug' ] ) 
             : ( $this->oProp->sDefaultPageSlug 
                 ? $this->oProp->sDefaultPageSlug 
@@ -132,7 +132,7 @@ 
         $aSection[ 'section_tab_slug' ]   = $this->oUtil->sanitizeSlug( $aSection[ 'section_tab_slug' ] );
         
         // A page slug is required.
-        if ( ! $aSection[ 'page_slug' ] ) {
+        if ( !$aSection[ 'page_slug' ] ) {
             return; 
         }
         $this->oForm->addSection( $aSection );
@@ -160,7 +160,7 @@ 
     */    
     public function removeSettingSections( /* $sSectionID1=null, $sSectionID2=null, $_and_more=null */ ) {    
         
-        foreach( func_get_args() as $_sSectionID ) {
+        foreach ( func_get_args() as $_sSectionID ) {
             $this->oForm->removeSection( $_sSectionID );
         }
         
@@ -219,7 +219,7 @@ 
      * @remark      The actual registration will be performed in the <em>_replyToRegisterSettings()</em> method with the <em>admin_menu</em> hook.
      */     
     public function addSettingFields( /* $aField1, $aField2=null, $_and_more=null */ ) {    
-        foreach( func_get_args() as $aField ) { 
+        foreach ( func_get_args() as $aField ) { 
             $this->addSettingField( $aField ); 
         }
     }
@@ -256,8 +256,8 @@ 
     * @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 ) { 
+    public function removeSettingFields( $sFieldID1, $sFieldID2 = null, $_and_more ) {
+        foreach ( func_get_args() as $_sFieldID ) { 
             $this->oForm->removeField( $_sFieldID ); 
         }
     }    
@@ -304,7 +304,7 @@ 
             $this->oProp->sOptionKey, 
             empty( $_aParams ) 
                 ? null                  // will return the entire options array
-                : $_aDimensionalKeys,   // dimensional keys
+                : $_aDimensionalKeys, // dimensional keys
             $_mDefault, // default
             $this->getSavedOptions() + $this->oForm->getDefaultFormValues()
         );
@@ -323,18 +323,18 @@ 
      * If the user has not submitted the form, the framework will try to return the default value set in the field definition array.
      * @deprecated  3.3.0
      */
-    public function getFieldValue( $sFieldID, $sSectionID='' ) {
+    public function getFieldValue( $sFieldID, $sSectionID = '' ) {
                                
-        trigger_error( 'Admin Page Framework: ' . ' : ' . sprintf( __( 'The method is deprecated: %1$s. Use %2$s instead.', $this->oProp->sTextDomain ), __METHOD__, 'getValue()' ), E_USER_WARNING );
+        trigger_error( 'Admin Page Framework: '.' : '.sprintf( __( 'The method is deprecated: %1$s. Use %2$s instead.', $this->oProp->sTextDomain ), __METHOD__, 'getValue()' ), E_USER_WARNING );
     
         $_aOptions = $this->oUtil->uniteArrays( $this->oProp->aOptions, $this->oForm->getDefaultFormValues() );
         /* If it's saved, return it */
-        if ( ! $sSectionID ) {
+        if ( !$sSectionID ) {
             if ( array_key_exists( $sFieldID, $_aOptions ) ) {
                 return $_aOptions[ $sFieldID ];
             }    
             // loop through section elements
-            foreach( $_aOptions as $aOptions ) {
+            foreach ( $_aOptions as $aOptions ) {
                 if ( array_key_exists( $sFieldID, $aOptions ) ) {
                     return $aOptions[ $sFieldID ];
                 }

Braces +5 added lines, -5 removed lines

@@ -72,7 +72,7 @@ 
      */     
     public function addSettingSections( /* $aSection1, $aSection2=null, $_and_more=null */ ) {
         
-        foreach( func_get_args() as $asSection ) { 
+        foreach( func_get_args() as $asSection ) {
             $this->addSettingSection( $asSection ); 
         }
         
@@ -158,7 +158,7 @@ 
     * @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 */ ) {    
+    public function removeSettingSections( /* $sSectionID1=null, $sSectionID2=null, $_and_more=null */ ) {
         
         foreach( func_get_args() as $_sSectionID ) {
             $this->oForm->removeSection( $_sSectionID );
@@ -218,8 +218,8 @@ 
      * @remark      Accepts variadic parameters; the number of accepted parameters are not limited to three.
      * @remark      The actual registration will be performed in the <em>_replyToRegisterSettings()</em> method with the <em>admin_menu</em> hook.
      */     
-    public function addSettingFields( /* $aField1, $aField2=null, $_and_more=null */ ) {    
-        foreach( func_get_args() as $aField ) { 
+    public function addSettingFields( /* $aField1, $aField2=null, $_and_more=null */ ) {
+        foreach( func_get_args() as $aField ) {
             $this->addSettingField( $aField ); 
         }
     }
@@ -257,7 +257,7 @@ 
     * @return void
     */    
     public function removeSettingFields( $sFieldID1, $sFieldID2=null, $_and_more ) {
-        foreach( func_get_args() as $_sFieldID ) { 
+        foreach( func_get_args() as $_sFieldID ) {
             $this->oForm->removeField( $_sFieldID ); 
         }
     }    

development/factory/admin_page/AdminPageFramework_Controller_Menu.php

Doc Comments +3 added lines

@@ -48,6 +48,8 @@ 
      *  <li>a base64-encoded SVG using a data URI, which will be colored to match the color scheme. This should begin with 'data:image/svg+xml;base64,'.</li>
      * </ul>
      * @param       string      (optional) the position number that is passed to the <var>$position</var> parameter of the <a href="http://codex.wordpress.org/Function_Reference/add_menu_page">add_menu_page()</a> function.
+     * @param string $sIcon16x16
+     * @param integer $iMenuPosition
      * @return      void
      */
     public function setRootMenuPage( $sRootMenuLabel, $sIcon16x16=null, $iMenuPosition=null ) {
@@ -70,6 +72,7 @@ 
          * 
          * @since       2.0.0
          * @internal
+         * @param string $sMenuLabel
          * @return      void|string Returns the associated slug string, if true.
          */ 
         private function _isBuiltInMenuItem( $sMenuLabel ) {

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.

Spacing +9 added lines, -9 removed lines

@@ -50,7 +50,7 @@ 
      * @param       string      (optional) the position number that is passed to the <var>$position</var> parameter of the <a href="http://codex.wordpress.org/Function_Reference/add_menu_page">add_menu_page()</a> function.
      * @return      void
      */
-    public function setRootMenuPage( $sRootMenuLabel, $sIcon16x16=null, $iMenuPosition=null ) {
+    public function setRootMenuPage( $sRootMenuLabel, $sIcon16x16 = null, $iMenuPosition = null ) {
 
         $sRootMenuLabel = trim( $sRootMenuLabel );
         $_sSlug         = $this->_isBuiltInMenuItem( $sRootMenuLabel ); // if true, this method returns the slug
@@ -98,8 +98,8 @@ 
      */ 
     public function setRootMenuPageBySlug( $sRootMenuSlug ) {
         
-        $this->oProp->aRootMenu['sPageSlug']    = $sRootMenuSlug; // do not sanitize the slug here because post types includes a question mark.
-        $this->oProp->aRootMenu['fCreateRoot']  = false; // indicates to use an existing menu item. 
+        $this->oProp->aRootMenu[ 'sPageSlug' ]    = $sRootMenuSlug; // do not sanitize the slug here because post types includes a question mark.
+        $this->oProp->aRootMenu[ 'fCreateRoot' ]  = false; // indicates to use an existing menu item. 
         
     }
     
@@ -137,7 +137,7 @@ 
     * @access       public
     * @return       void
     */     
-    public function addSubMenuItems( $aSubMenuItem1, $aSubMenuItem2=null, $_and_more=null ) {
+    public function addSubMenuItems( $aSubMenuItem1, $aSubMenuItem2 = null, $_and_more = null ) {
         foreach ( func_get_args() as $_aSubMenuItem ) {
             $this->addSubMenuItem( $_aSubMenuItem );     
         }
@@ -214,16 +214,16 @@ 
     public function addSubMenuLink( array $aSubMenuLink ) {
         
         // If required keys are not set, return.
-        if ( ! isset( $aSubMenuLink['href'], $aSubMenuLink['title'] ) ) { 
+        if ( !isset( $aSubMenuLink[ 'href' ], $aSubMenuLink[ 'title' ] ) ) { 
             return; 
         }
         
         // If the set URL is not valid, return.
-        if ( ! filter_var( $aSubMenuLink['href'], FILTER_VALIDATE_URL ) ) { 
+        if ( !filter_var( $aSubMenuLink[ 'href' ], FILTER_VALIDATE_URL ) ) { 
             return; 
         }
 
-        $_oFormatter   = new AdminPageFramework_Format_SubMenuLink( 
+        $_oFormatter = new AdminPageFramework_Format_SubMenuLink( 
             $aSubMenuLink, 
             $this 
         );
@@ -312,11 +312,11 @@ 
      */ 
     public function addSubMenuPage( array $aSubMenuPage ) {
 
-        if ( ! isset( $aSubMenuPage[ 'page_slug' ] ) ) { 
+        if ( !isset( $aSubMenuPage[ 'page_slug' ] ) ) { 
             return; 
         }
             
-        $_oFormatter   = new AdminPageFramework_Format_SubMenuPage( 
+        $_oFormatter = new AdminPageFramework_Format_SubMenuPage( 
             $aSubMenuPage,
             $this 
         );

Braces +6 added lines, -5 removed lines

@@ -75,8 +75,9 @@ 
         private function _isBuiltInMenuItem( $sMenuLabel ) {
             
             $_sMenuLabelLower = strtolower( $sMenuLabel );
-            if ( array_key_exists( $_sMenuLabelLower, $this->_aBuiltInRootMenuSlugs ) )
-                return $this->_aBuiltInRootMenuSlugs[ $_sMenuLabelLower ];
+            if ( array_key_exists( $_sMenuLabelLower, $this->_aBuiltInRootMenuSlugs ) ) {
+                            return $this->_aBuiltInRootMenuSlugs[ $_sMenuLabelLower ];
+            }
             
         }    
 
@@ -214,12 +215,12 @@ 
     public function addSubMenuLink( array $aSubMenuLink ) {
         
         // If required keys are not set, return.
-        if ( ! isset( $aSubMenuLink['href'], $aSubMenuLink['title'] ) ) { 
+        if ( ! isset( $aSubMenuLink['href'], $aSubMenuLink['title'] ) ) {
             return; 
         }
         
         // If the set URL is not valid, return.
-        if ( ! filter_var( $aSubMenuLink['href'], FILTER_VALIDATE_URL ) ) { 
+        if ( ! filter_var( $aSubMenuLink['href'], FILTER_VALIDATE_URL ) ) {
             return; 
         }
 
@@ -312,7 +313,7 @@ 
      */ 
     public function addSubMenuPage( array $aSubMenuPage ) {
 
-        if ( ! isset( $aSubMenuPage[ 'page_slug' ] ) ) { 
+        if ( ! isset( $aSubMenuPage[ 'page_slug' ] ) ) {
             return; 
         }
             

development/factory/admin_page/AdminPageFramework_Controller_Page.php

Doc Comments +4 added lines, -36 removed lines

@@ -52,42 +52,6 @@ 
      * @since       2.0.0
      * @since       3.0.0     Changed the scope to public. Added page slug target support. 
      * @since       3.3.1       Moved from `AdminPageFramework_Page`.
-     * @param       array     $aTab1 The in-page tab array.
-     * <h4>In-Page Tab Array</h4>
-     * <ul>
-     *     <li>**page_slug** - (string) the page slug that the tab belongs to.</li>
-     *     <li>**tab_slug** -  (string) the tab slug. Non-alphabetical characters should not be used including dots(.) and hyphens(-).</li>
-     *     <li>**title** - (string) the title of the tab.</li>
-     *     <li>**order** - (optional, integer) the order number of the tab. The lager the number is, the lower the position it is placed in the menu.</li>
-     *     <li>**show_in_page_tab** - (optional, boolean) default: `true`. If this is set to `false`, the tab title will not be displayed in the tab navigation menu; however, it is still accessible from the direct URL.</li>
-     *     <li>**parent_tab_slug** - (optional, string) this needs to be set if the above `show_in_page_tab` argument is `false` so that the parent tab will be emphasized as active when the hidden page is accessed.</li>
-     *     <li>**url** - [3.5.0+] (optional, string) If this is set, the link url of the navigation tab will be this url. Use this to create link only tab.</li>
-     *     <li>**capability** - [3.6.0+] (optional, string) The capability level.</li>
-     *     <li>**if** - [3.6.0+] (optional, boolean) Whether the tab should be displayed or not.</li>
-     *     <li>style - [3.6.3+] (optional) (string|array) The path or url of a stylesheet which gets loaded in the head tag. Or inline CSS rules.
-     * When custom arguments need to be set such as whether it should be inserted in the footer, set an array holding the following arguments.
-     *          <ul>
-     *              <li>src - (required, string) the source url or path.</li>    
-     *              <li>handle_id - (optional, string) The handle ID of the stylesheet.</li>    
-     *              <li>dependencies - (optional, array) The dependency array.</li>    
-     *              <li>version - (optional, string) The stylesheet version number.</li>    
-     *              <li>media - (optional, string) the description of the field which is inserted into the after the input field tag.</li>    
-     *          </ul>
-     *     </li>
-     *     <li>script - [3.6.3+] (optional) (string|array) The path or url of a JavaScript script which gets loaded in the head tag. Or an inline JavaScript script.
-     * When custom arguments need to be set such as whether it should be inserted in the footer, set an array holding the following arguments.
-     *          <ul>
-     *              <li>src - (required, string) the source url or path.</li>    
-     *              <li>handle_id - (optional, string) The handle ID of the stylesheet.</li>    
-     *              <li>dependencies - (optional, array) The dependency array.</li>    
-     *              <li>version - (optional, string) The stylesheet version number.</li>    
-     *              <li>translation - (optional, array) an array holding translation key-value pairs.</li>    
-     *          </ul>
-     *     </li>
-     * </ul>
-     * @param       array       $aTab2      Another in-page tab array.
-     * @param       array       $_and_more  (optional) Add in-page tab arrays as many as necessary to the next parameters.
-     * @param       string      $sPageSlug  (optional) If the passed parameter item is a string, it will be stored as the target page slug so that it will be applied to the next passed tab arrays as the page_slug element.
      * @remark      Accepts variadic parameters; the number of accepted parameters are not limited to three.
      * @remark      In-page tabs are different from page-heading tabs which is automatically added with page titles.  
      * @return      void
@@ -277,6 +241,10 @@ 
         /**
          * Sets a page property.
          * @since       3.6.0
+         * @param string $sPropertyName
+         * @param string $sPropertyKey
+         * @param boolean|string $mValue
+         * @param string $sPageSlug
          * @return      void
          */
         private function _setPageProperty( $sPropertyName, $sPropertyKey, $mValue, $sPageSlug ) {

Spacing +14 added lines, -14 removed lines

@@ -93,7 +93,7 @@ 
      * @return      void
      */             
     public function addInPageTabs( /* $aTab1, $aTab2=null, $_and_more=null */ ) {
-        foreach( func_get_args() as $asTab ) { 
+        foreach ( func_get_args() as $asTab ) { 
             $this->addInPageTab( $asTab ); 
         }
     }
@@ -115,7 +115,7 @@ 
         
         // Target page slug - will be applied when no page slug is specified.
         static $__sTargetPageSlug; 
-        if ( ! is_array( $asInPageTab ) ) {
+        if ( !is_array( $asInPageTab ) ) {
             $__sTargetPageSlug = is_string( $asInPageTab ) 
                 ? $asInPageTab 
                 : $__sTargetPageSlug; // set the target page slug
@@ -130,23 +130,23 @@ 
         );
         
         // Set the target page slug for next calls
-        $__sTargetPageSlug  = $aInPageTab[ 'page_slug' ]; 
+        $__sTargetPageSlug = $aInPageTab[ 'page_slug' ]; 
 
         // Required keys
-        if ( ! isset( $aInPageTab[ 'page_slug' ], $aInPageTab[ 'tab_slug' ] ) ) { 
+        if ( !isset( $aInPageTab[ 'page_slug' ], $aInPageTab[ 'tab_slug' ] ) ) { 
             return; 
         }
         
         // Count - the number of added in-page tabs.
-        $_aElements         = $this->oUtil->getElement(
+        $_aElements = $this->oUtil->getElement(
             $this->oProp->aInPageTabs,
             $aInPageTab[ 'page_slug' ],
             array()
         );
-        $_iCountElement      = count( $_aElements );
+        $_iCountElement = count( $_aElements );
 
         // Pre-format
-        $aInPageTab         = array( 
+        $aInPageTab = array( 
             'page_slug' => $this->oUtil->sanitizeSlug( $aInPageTab[ 'page_slug' ] ),
             'tab_slug'  => $this->oUtil->sanitizeSlug( $aInPageTab[ 'tab_slug' ] ),
             'order'     => $this->oUtil->getAOrB(
@@ -174,7 +174,7 @@ 
      * @param       boolean     $bShow If false, the page title will not be displayed.
      * @return      void
      */ 
-    public function setPageTitleVisibility( $bShow=true, $sPageSlug='' ) {
+    public function setPageTitleVisibility( $bShow = true, $sPageSlug = '' ) {
         $this->_setPageProperty( 
             'bShowPageTitle', 
             'show_page_title', 
@@ -198,7 +198,7 @@ 
      * @remark      Page-heading tabs and in-page tabs are different. The former displays page titles and the latter displays tab titles.
      * @remark      If the second parameter is omitted, it sets the default value.
      */ 
-    public function setPageHeadingTabsVisibility( $bShow=true, $sPageSlug='' ) {
+    public function setPageHeadingTabsVisibility( $bShow = true, $sPageSlug = '' ) {
         $this->_setPageProperty( 
             'bShowPageHeadingTabs', 
             'show_page_heading_tabs', 
@@ -219,7 +219,7 @@ 
      * @param       string      $sPageSlug  The page to apply the visibility setting. If not set, it applies to all the pages.
      * @remark      If the second parameter is omitted, it sets the default value.
      */
-    public function setInPageTabsVisibility( $bShow=true, $sPageSlug='' ) {
+    public function setInPageTabsVisibility( $bShow = true, $sPageSlug = '' ) {
         $this->_setPageProperty( 
             'bShowInPageTabs', 
             'show_in_page_tabs', 
@@ -242,7 +242,7 @@ 
      * @param       string      $sPageSlug      The page slug that applies the setting.    
      * @remark      If the second parameter is omitted, it sets the default value.
      */     
-    public function setInPageTabTag( $sTag='h3', $sPageSlug='' ) {      
+    public function setInPageTabTag( $sTag = 'h3', $sPageSlug = '' ) {      
         $this->_setPageProperty( 
             'sInPageTabTag', 
             'in_page_tab_tag', 
@@ -265,9 +265,9 @@ 
      * @param       string      $sPageSlug  The page slug that applies the setting.    
      * @remark      If the second parameter is omitted, it sets the default value.
      */
-    public function setPageHeadingTabTag( $sTag='h2', $sPageSlug='' ) {
+    public function setPageHeadingTabTag( $sTag = 'h2', $sPageSlug = '' ) {
         $this->_setPageProperty( 
-            'sPageHeadingTabTag',   // property name
+            'sPageHeadingTabTag', // property name
             'page_heading_tab_tag', // property key
             $sTag, // value
             $sPageSlug  // page slug
@@ -289,7 +289,7 @@ 
             
             $this->oProp->{$sPropertyName} = $mValue;
        
-            foreach( $this->oProp->aPages as &$_aPage ) {
+            foreach ( $this->oProp->aPages as &$_aPage ) {
                 $_aPage[ $sPropertyKey ] = $mValue;
 
             }                        

Braces +4 added lines, -4 removed lines

@@ -93,7 +93,7 @@ 
      * @return      void
      */             
     public function addInPageTabs( /* $aTab1, $aTab2=null, $_and_more=null */ ) {
-        foreach( func_get_args() as $asTab ) { 
+        foreach( func_get_args() as $asTab ) {
             $this->addInPageTab( $asTab ); 
         }
     }
@@ -111,7 +111,7 @@ 
      * @remark      In-page tabs are different from page-heading tabs which are automatically added with page titles.
      * @return      void
      */         
-    public function addInPageTab( $asInPageTab ) {    
+    public function addInPageTab( $asInPageTab ) {
         
         // Target page slug - will be applied when no page slug is specified.
         static $__sTargetPageSlug; 
@@ -133,7 +133,7 @@ 
         $__sTargetPageSlug  = $aInPageTab[ 'page_slug' ]; 
 
         // Required keys
-        if ( ! isset( $aInPageTab[ 'page_slug' ], $aInPageTab[ 'tab_slug' ] ) ) { 
+        if ( ! isset( $aInPageTab[ 'page_slug' ], $aInPageTab[ 'tab_slug' ] ) ) {
             return; 
         }
         
@@ -242,7 +242,7 @@ 
      * @param       string      $sPageSlug      The page slug that applies the setting.    
      * @remark      If the second parameter is omitted, it sets the default value.
      */     
-    public function setInPageTabTag( $sTag='h3', $sPageSlug='' ) {      
+    public function setInPageTabTag( $sTag='h3', $sPageSlug='' ) {
         $this->_setPageProperty( 
             'sInPageTabTag', 
             'in_page_tab_tag', 

development/factory/admin_page/AdminPageFramework_Model_Menu.php

Doc Comments +1 added lines

@@ -24,6 +24,7 @@
      * Registers necessary callbacks and sets up properties.
      * 
      * @internal
+     * @param string $sCallerPath
      */
     public function __construct( $sOptionKey=null, $sCallerPath=null, $sCapability='manage_options', $sTextDomain='admin-page-framework' ) {
         

Spacing +46 added lines, -46 removed lines

@@ -25,7 +25,7 @@ 
      * 
      * @internal
      */
-    public function __construct( $sOptionKey=null, $sCallerPath=null, $sCapability='manage_options', $sTextDomain='admin-page-framework' ) {
+    public function __construct( $sOptionKey = null, $sCallerPath = null, $sCapability = 'manage_options', $sTextDomain = 'admin-page-framework' ) {
         
         parent::__construct( $sOptionKey, $sCallerPath, $sCapability, $sTextDomain );
         
@@ -126,7 +126,7 @@ 
 
             foreach ( $this->oProp->aPages as $_aPage ) {
                 
-                if ( ! isset( $_aPage[ 'page_slug' ] ) ) { 
+                if ( !isset( $_aPage[ 'page_slug' ] ) ) { 
                     continue; 
                 }
                 $this->oProp->sDefaultPageSlug = $_aPage[ 'page_slug' ];
@@ -144,12 +144,12 @@ 
          */ 
         private function _registerRootMenuPage() {
             $this->oProp->aRootMenu[ '_page_hook' ] = add_menu_page(  
-                $this->oProp->sClassName,                 // Page title - will be invisible anyway
-                $this->oProp->aRootMenu[ 'sTitle' ],      // Menu title - should be the root page title.
-                $this->oProp->sCapability,                // Capability - access right
-                $this->oProp->aRootMenu[ 'sPageSlug' ],   // Menu ID 
-                '',                                       // Page content displaying function - the root page will be removed so no need to register a function.
-                $this->oProp->aRootMenu[ 'sIcon16x16' ],  // icon path
+                $this->oProp->sClassName, // Page title - will be invisible anyway
+                $this->oProp->aRootMenu[ 'sTitle' ], // Menu title - should be the root page title.
+                $this->oProp->sCapability, // Capability - access right
+                $this->oProp->aRootMenu[ 'sPageSlug' ], // Menu ID 
+                '', // Page content displaying function - the root page will be removed so no need to register a function.
+                $this->oProp->aRootMenu[ 'sIcon16x16' ], // icon path
                 $this->oUtil->getElement( 
                     $this->oProp->aRootMenu, 
                     'iPosition', 
@@ -173,32 +173,32 @@ 
          */ 
         private function _registerSubMenuItem( array $aArgs ) {
 
-            if ( ! current_user_can( $aArgs['capability'] ) ) {
+            if ( !current_user_can( $aArgs[ 'capability' ] ) ) {
                 return '';
             }
                  
-            $_sRootPageSlug = $this->oProp->aRootMenu['sPageSlug'];
+            $_sRootPageSlug = $this->oProp->aRootMenu[ 'sPageSlug' ];
             $_sMenuSlug     = plugin_basename( $_sRootPageSlug ); // to be compatible with add_submenu_page()
             
-            switch( $aArgs['type'] ) {
+            switch ( $aArgs[ 'type' ] ) {
                 case 'page':
                     // it's possible that the page_slug key is not set if the user uses a method like setPageHeadingTabsVisibility() prior to addSubMenuItam().
                     return $this->_addPageSubmenuItem(
                         $_sRootPageSlug,
                         $_sMenuSlug,
-                        $aArgs['page_slug'],
-                        $this->oUtil->getElement( $aArgs, 'page_title', $aArgs['title'] ),
-                        $this->oUtil->getElement( $aArgs, 'menu_title', $aArgs['title'] ),
-                        $aArgs['capability'],
-                        $aArgs['show_in_menu']
+                        $aArgs[ 'page_slug' ],
+                        $this->oUtil->getElement( $aArgs, 'page_title', $aArgs[ 'title' ] ),
+                        $this->oUtil->getElement( $aArgs, 'menu_title', $aArgs[ 'title' ] ),
+                        $aArgs[ 'capability' ],
+                        $aArgs[ 'show_in_menu' ]
                     );
                 case 'link':
                     return $this->_addLinkSubmenuItem( 
                         $_sMenuSlug, 
-                        $aArgs['title'], 
-                        $aArgs['capability'],
-                        $aArgs['href'],
-                        $aArgs['show_in_menu']
+                        $aArgs[ 'title' ], 
+                        $aArgs[ 'capability' ],
+                        $aArgs[ 'href' ],
+                        $aArgs[ 'show_in_menu' ]
                     );
                 default:
                     return '';
@@ -214,43 +214,43 @@ 
              */
             private function _addPageSubmenuItem( $sRootPageSlug, $sMenuSlug, $sPageSlug, $sPageTitle, $sMenuTitle, $sCapability, $bShowInMenu ) {
                 
-                if ( ! $sPageSlug ) {
+                if ( !$sPageSlug ) {
                     return '';
                 }
                 $_sPageHook = add_submenu_page( 
-                    $sRootPageSlug,         // the root(parent) page slug
-                    $sPageTitle,            // page title
-                    $sMenuTitle,            // menu title
-                    $sCapability,           // capability
-                    $sPageSlug,             // menu slug
+                    $sRootPageSlug, // the root(parent) page slug
+                    $sPageTitle, // page title
+                    $sMenuTitle, // menu title
+                    $sCapability, // capability
+                    $sPageSlug, // menu slug
                     // In admin.php ( line 149 of WordPress v3.6.1 ), do_action($page_hook) ( where $page_hook is $_sPageHook )
                     // will be executed and it triggers the __call() magic method with the method name of "md5 class hash + _page_ + this page slug".
-                    array( $this, $this->oProp->sClassHash . '_page_' . $sPageSlug )
+                    array( $this, $this->oProp->sClassHash.'_page_'.$sPageSlug )
                 );     
                 
                 // Ensure only it is added one time per page slug.
-                if ( ! isset( $this->oProp->aPageHooks[ $_sPageHook ] ) ) {
+                if ( !isset( $this->oProp->aPageHooks[ $_sPageHook ] ) ) {
                     // 3.4.1+ Give a lower priority as the page meta box class also hooks the current_screen to register form elements.
                     // When the validation callback is triggered, their form registration should be done already. So this hook should be loaded later than them.
-                    add_action( 'current_screen' , array( $this, "load_pre_" . $sPageSlug ), 20 );
+                    add_action( 'current_screen', array( $this, "load_pre_".$sPageSlug ), 20 );
                     
                     // 3.6.3+
                     // It is possible that an in-page tab is added during the above hooks and the current page is the default tab without the tab GET query key in the url. 
                     // Set a low priority because the user may add in-page tabs in their callback method of this action hook.
-                    add_action( "load_" . $sPageSlug, array( $this, '_replyToFinalizeInPageTabs' ), 9999 );
+                    add_action( "load_".$sPageSlug, array( $this, '_replyToFinalizeInPageTabs' ), 9999 );
                     
                     // 3.6.3+
-                    add_action( "load_after_" . $sPageSlug, array( $this, '_replyToEnqueuePageAssets' ) );
+                    add_action( "load_after_".$sPageSlug, array( $this, '_replyToEnqueuePageAssets' ) );
                     
                 }
                 $this->oProp->aPageHooks[ $sPageSlug ] = $this->oUtil->getAOrB(
                     is_network_admin(),
-                    $_sPageHook . '-network',
+                    $_sPageHook.'-network',
                     $_sPageHook
                 );
                 
                 // If the visibility option is false, remove the one just added from the sub-menu array
-                if ( ! $bShowInMenu ) {
+                if ( !$bShowInMenu ) {
                     $this->_removePageSubmenuItem( $sMenuSlug, $sMenuTitle, $sPageTitle, $sPageSlug );
                 }                
                 return $_sPageHook;
@@ -263,11 +263,11 @@ 
                  * @since       3.1.1       Moved from `AdminPageFramework_Menu`.
                  * @return      void
                  */
-                private function _removePageSubmenuItem( $sMenuSlug, $sMenuTitle, $sPageTitle, $sPageSlug ){
+                private function _removePageSubmenuItem( $sMenuSlug, $sMenuTitle, $sPageTitle, $sPageSlug ) {
                     
-                    foreach( ( array ) $GLOBALS['submenu'][ $sMenuSlug ] as $_iIndex => $_aSubMenu ) {
+                    foreach ( ( array ) $GLOBALS[ 'submenu' ][ $sMenuSlug ] as $_iIndex => $_aSubMenu ) {
                       
-                        if ( ! isset( $_aSubMenu[ 3 ] ) ) { 
+                        if ( !isset( $_aSubMenu[ 3 ] ) ) { 
                             continue; 
                         }
                                                
@@ -318,15 +318,15 @@ 
                         
                         // If it is in the network admin area, do not remove the menu; otherwise, it gets not accessible. 
                         if ( is_network_admin() ) {
-                            unset( $GLOBALS['submenu'][ $sMenuSlug ][ $_iIndex ] );
+                            unset( $GLOBALS[ 'submenu' ][ $sMenuSlug ][ $_iIndex ] );
                             return;
                         } 
                         
                         if ( 
-                            ! isset( $_GET['page'] ) 
-                            || isset( $_GET['page'] ) && $sPageSlug != $_GET['page'] 
+                            !isset( $_GET[ 'page' ] ) 
+                            || isset( $_GET[ 'page' ] ) && $sPageSlug != $_GET[ 'page' ] 
                         ) {
-                            unset( $GLOBALS['submenu'][ $sMenuSlug ][ $_iIndex ] );
+                            unset( $GLOBALS[ 'submenu' ][ $sMenuSlug ][ $_iIndex ] );
                         }                        
                         
                     }
@@ -339,13 +339,13 @@ 
              * @return      void
              */
             private function _addLinkSubmenuItem( $sMenuSlug, $sTitle, $sCapability, $sHref, $bShowInMenu ) {
-                if ( ! $bShowInMenu ) {
+                if ( !$bShowInMenu ) {
                     return;
                 }
-                if ( ! isset( $GLOBALS['submenu'][ $sMenuSlug ] ) ) {
-                    $GLOBALS['submenu'][ $sMenuSlug ] = array();
+                if ( !isset( $GLOBALS[ 'submenu' ][ $sMenuSlug ] ) ) {
+                    $GLOBALS[ 'submenu' ][ $sMenuSlug ] = array();
                 }
-                $GLOBALS['submenu'][ $sMenuSlug ][] = array ( 
+                $GLOBALS[ 'submenu' ][ $sMenuSlug ][ ] = array( 
                     $sTitle, 
                     $sCapability, 
                     $sHref,
@@ -360,8 +360,8 @@ 
          * @internal
          */
         public function _replyToFixPageTitleForHiddenPages( $sAdminTitle, $sPageTitle ) {
-            if ( isset( $_GET['page'], $this->oProp->aHiddenPages[ $_GET['page'] ] ) ) {
-                return $this->oProp->aHiddenPages[ $_GET['page'] ] . $sAdminTitle;
+            if ( isset( $_GET[ 'page' ], $this->oProp->aHiddenPages[ $_GET[ 'page' ] ] ) ) {
+                return $this->oProp->aHiddenPages[ $_GET[ 'page' ] ].$sAdminTitle;
             }    
             return $sAdminTitle;     
         }  

Braces +4 added lines, -4 removed lines

@@ -126,7 +126,7 @@ 
 
             foreach ( $this->oProp->aPages as $_aPage ) {
                 
-                if ( ! isset( $_aPage[ 'page_slug' ] ) ) { 
+                if ( ! isset( $_aPage[ 'page_slug' ] ) ) {
                     continue; 
                 }
                 $this->oProp->sDefaultPageSlug = $_aPage[ 'page_slug' ];
@@ -263,11 +263,11 @@ 
                  * @since       3.1.1       Moved from `AdminPageFramework_Menu`.
                  * @return      void
                  */
-                private function _removePageSubmenuItem( $sMenuSlug, $sMenuTitle, $sPageTitle, $sPageSlug ){
+                private function _removePageSubmenuItem( $sMenuSlug, $sMenuTitle, $sPageTitle, $sPageSlug ) {
                     
                     foreach( ( array ) $GLOBALS['submenu'][ $sMenuSlug ] as $_iIndex => $_aSubMenu ) {
                       
-                        if ( ! isset( $_aSubMenu[ 3 ] ) ) { 
+                        if ( ! isset( $_aSubMenu[ 3 ] ) ) {
                             continue; 
                         }
                                                
@@ -282,7 +282,7 @@ 
                             $sPageTitle,
                             $sPageSlug,
                         );
-                        if ( $_aA !== $_aB ) { 
+                        if ( $_aA !== $_aB ) {
                             continue;
                         }
 

development/factory/admin_page/form/AdminPageFramework_Form_admin_page.php

Doc Comments +1 added lines

@@ -455,6 +455,7 @@
      * @internal
      * @since       3.5.3
      * @since       DEVVER      Moved from `AdminPageFramework_FormDefinition_Page`.
+     * @param string $sTabSlug
      * @return      boolean
      */
     private function _isThisSectionSetToThisTab( $_sSectionID, $sPageSlug, $sTabSlug ) {

Spacing +19 added lines, -19 removed lines

@@ -52,16 +52,16 @@ 
     public function getPageOnlyOptions( $aOptions, $sPageSlug ) {
 
         $_aStoredOptionsOfThePage = array();
-        foreach( $this->aFieldsets as $_sSectionID => $_aSubSectionsOrFields ) {
+        foreach ( $this->aFieldsets as $_sSectionID => $_aSubSectionsOrFields ) {
             
             // Check the section
-            if ( ! $this->_isThisSectionSetToThisPage( $_sSectionID, $sPageSlug ) ) {
+            if ( !$this->_isThisSectionSetToThisPage( $_sSectionID, $sPageSlug ) ) {
                 continue;
             }
 
             // At this point, the element belongs the given page slug as the section is of the given page slug's.
             $this->_setPageOnlyOptions( 
-                $_aStoredOptionsOfThePage,  // by reference - gets updated in the method.
+                $_aStoredOptionsOfThePage, // by reference - gets updated in the method.
                 $aOptions, 
                 $_aSubSectionsOrFields, 
                 $sPageSlug,
@@ -81,7 +81,7 @@ 
          * @internal
          */
         private function _setPageOnlyOptions( array &$_aStoredOptionsOfThePage, array $aOptions, array $_aSubSectionsOrFields, $sPageSlug, $_sSectionID ) {
-            foreach( $_aSubSectionsOrFields as $_sFieldID => $_aFieldset ) {
+            foreach ( $_aSubSectionsOrFields as $_sFieldID => $_aFieldset ) {
                 
                 // If it's a sub-section array,
                 if ( $this->isNumericInteger( $_sFieldID ) ) {
@@ -153,7 +153,7 @@ 
     public function getOtherPageOptions( $aOptions, $sPageSlug ) {
 
         $_aStoredOptionsNotOfThePage = array();
-        foreach( $this->aFieldsets as $_sSectionID => $_aSubSectionsOrFields ) {
+        foreach ( $this->aFieldsets as $_sSectionID => $_aSubSectionsOrFields ) {
             
             // Check the section
             if ( $this->_isThisSectionSetToThisPage( $_sSectionID, $sPageSlug ) ) {
@@ -182,7 +182,7 @@ 
          * @internal
          */
         private function _setOtherPageOptions( array &$_aStoredOptionsNotOfThePage, array $aOptions, array $_aSubSectionsOrFields, $sPageSlug ) {
-            foreach( $_aSubSectionsOrFields as $_sFieldID => $_aFieldset ) {
+            foreach ( $_aSubSectionsOrFields as $_sFieldID => $_aFieldset ) {
 
                 // It's a sub-section array. 
                 if ( $this->isNumericInteger( $_sFieldID ) ) {
@@ -245,7 +245,7 @@ 
     public function getOtherTabOptions( $aOptions, $sPageSlug, $sTabSlug ) {
 
         $_aStoredOptionsNotOfTheTab = array();
-        foreach( $this->aFieldsets as $_sSectionPath => $_aSubSectionsOrFields ) {
+        foreach ( $this->aFieldsets as $_sSectionPath => $_aSubSectionsOrFields ) {
                         
             // If the section is of the given page and the given tab, skip.
             if ( $this->_isThisSectionSetToThisTab( $_sSectionPath, $sPageSlug, $sTabSlug ) ) {
@@ -276,7 +276,7 @@ 
         private function _setOtherTabOptions( array &$_aStoredOptionsNotOfTheTab, array $aOptions, array $_aSubSectionsOrFields, $sSectionPath ) {
             
             // At this point, the passed element belongs to the other tabs since the section of the given tab is skipped.
-            foreach ( $_aSubSectionsOrFields as $_isSubSectionIndexOrFieldID => $_aSubSectionOrField  ) {
+            foreach ( $_aSubSectionsOrFields as $_isSubSectionIndexOrFieldID => $_aSubSectionOrField ) {
                 
                 // If it's a sub section
                 if ( $this->isNumericInteger( $_isSubSectionIndexOrFieldID ) ) {
@@ -333,7 +333,7 @@ 
      * @since       DEVVER      Moved from `AdminPageFramework_FormDefinition_Page`.
      * @return      array
      */
-    public function getTabOptions( $aOptions, $sPageSlug, $sTabSlug='' ) {     
+    public function getTabOptions( $aOptions, $sPageSlug, $sTabSlug = '' ) {     
         $_aOtherTabOptions = $this->getOtherTabOptions( $aOptions, $sPageSlug, $sTabSlug );
         return $this->invertCastArrayContents( $aOptions, $_aOtherTabOptions );     
     }
@@ -348,17 +348,17 @@ 
      * @since       DEVVER      Moved from `AdminPageFramework_FormDefinition_Page`.
      * @return      array
      */
-    public function getTabOnlyOptions( array $aOptions, $sPageSlug, $sTabSlug='' ) {
+    public function getTabOnlyOptions( array $aOptions, $sPageSlug, $sTabSlug = '' ) {
         
         $_aStoredOptionsOfTheTab = array();
-        if ( ! $sTabSlug ) { 
+        if ( !$sTabSlug ) { 
             return $_aStoredOptionsOfTheTab; 
         }
         
-        foreach( $this->aFieldsets as $_sSectionID => $_aSubSectionsOrFields ) {
+        foreach ( $this->aFieldsets as $_sSectionID => $_aSubSectionsOrFields ) {
              
             // Check the section
-            if ( ! $this->_isThisSectionSetToThisTab( $_sSectionID, $sPageSlug, $sTabSlug ) ) {
+            if ( !$this->_isThisSectionSetToThisTab( $_sSectionID, $sPageSlug, $sTabSlug ) ) {
                 continue;
             }
             
@@ -384,7 +384,7 @@ 
          */
         private function _setTabOnlyOptions( array &$_aStoredOptionsOfTheTab, array $aOptions, array $_aSubSectionsOrFields, $_sSectionID ) {
             
-            foreach( $_aSubSectionsOrFields as $_sFieldID => $_aFieldset ) {
+            foreach ( $_aSubSectionsOrFields as $_sFieldID => $_aFieldset ) {
                                 
                 // if it's a sub-section array.
                 if ( $this->isNumericInteger( $_sFieldID ) ) {
@@ -441,7 +441,7 @@ 
      */
     private function _isThisSectionSetToThisPage( $_sSectionID, $sPageSlug ) {
         
-        if ( ! isset( $this->aSectionsets[ $_sSectionID ][ 'page_slug' ] ) ) {
+        if ( !isset( $this->aSectionsets[ $_sSectionID ][ 'page_slug' ] ) ) {
             return false;
         }
         return ( 
@@ -459,10 +459,10 @@ 
      */
     private function _isThisSectionSetToThisTab( $_sSectionID, $sPageSlug, $sTabSlug ) {
         
-        if ( ! $this->_isThisSectionSetToThisPage( $_sSectionID, $sPageSlug ) ) {
+        if ( !$this->_isThisSectionSetToThisPage( $_sSectionID, $sPageSlug ) ) {
             return false;
         }
-        if ( ! isset( $this->aSectionsets[ $_sSectionID ][ 'tab_slug' ] ) ) {
+        if ( !isset( $this->aSectionsets[ $_sSectionID ][ 'tab_slug' ] ) ) {
             return false;
         }
         return (
@@ -479,9 +479,9 @@ 
      */
     private function _setOptionValue( &$aSubject, $asDimensionalPath, $aOptions ) {
         $_aDimensionalPath = $this->getAsArray( $asDimensionalPath );
-        $_mValue     = $this->getElement(
+        $_mValue = $this->getElement(
             $aOptions,
-            $_aDimensionalPath,    // as of DEVVER, it can be an array or string
+            $_aDimensionalPath, // as of DEVVER, it can be an array or string
             null
         );
         if ( isset( $_mValue ) ) {

Braces +3 added lines, -3 removed lines

@@ -107,7 +107,7 @@ 
                 );
                 // @todo Examine whether this check can be removed 
                 // as the section that hods this field is already checked above outside this loop.
-                if ( $sPageSlug !== $_aFieldset[ 'page_slug' ] ) { 
+                if ( $sPageSlug !== $_aFieldset[ 'page_slug' ] ) {
                     continue; 
                 }        
                 
@@ -333,7 +333,7 @@ 
      * @since       DEVVER      Moved from `AdminPageFramework_FormDefinition_Page`.
      * @return      array
      */
-    public function getTabOptions( $aOptions, $sPageSlug, $sTabSlug='' ) {     
+    public function getTabOptions( $aOptions, $sPageSlug, $sTabSlug='' ) {
         $_aOtherTabOptions = $this->getOtherTabOptions( $aOptions, $sPageSlug, $sTabSlug );
         return $this->invertCastArrayContents( $aOptions, $_aOtherTabOptions );     
     }
@@ -351,7 +351,7 @@ 
     public function getTabOnlyOptions( array $aOptions, $sPageSlug, $sTabSlug='' ) {
         
         $_aStoredOptionsOfTheTab = array();
-        if ( ! $sTabSlug ) { 
+        if ( ! $sTabSlug ) {
             return $_aStoredOptionsOfTheTab; 
         }
         

development/factory/meta_box/_controller/AdminPageFramework_HelpPane_MetaBox.php

Doc Comments +1 added lines

@@ -43,6 +43,7 @@
      * @since       2.1.0
      * @remark      This method just adds the given text into the class property. The actual registration will be performed with the <em>replyToRegisterHelpTabTextForMetaBox()</em> method.
      * @internal
+     * @param string $sHTMLContent
      */ 
     public function _addHelpText( $sHTMLContent, $sHTMLSidebarContent="" ) {
         

Spacing +9 added lines, -9 removed lines

@@ -44,10 +44,10 @@ 
      * @remark      This method just adds the given text into the class property. The actual registration will be performed with the <em>replyToRegisterHelpTabTextForMetaBox()</em> method.
      * @internal
      */ 
-    public function _addHelpText( $sHTMLContent, $sHTMLSidebarContent="" ) {
+    public function _addHelpText( $sHTMLContent, $sHTMLSidebarContent = "" ) {
         
-        $this->oProp->aHelpTabText[]        = "<div class='contextual-help-description'>" . $sHTMLContent . "</div>";
-        $this->oProp->aHelpTabTextSide[]    = "<div class='contextual-help-description'>" . $sHTMLSidebarContent . "</div>";
+        $this->oProp->aHelpTabText[ ]        = "<div class='contextual-help-description'>".$sHTMLContent."</div>";
+        $this->oProp->aHelpTabTextSide[ ]    = "<div class='contextual-help-description'>".$sHTMLSidebarContent."</div>";
         
     }
     
@@ -62,9 +62,9 @@ 
      * @remark      This method just adds the given text into the class property. The actual registration will be performed with the `replyToRegisterHelpTabTextForMetaBox()` method.
      * @internal
      */     
-    public function _addHelpTextForFormFields( $sFieldTitle, $sHelpText, $sHelpTextSidebar="" ) {
+    public function _addHelpTextForFormFields( $sFieldTitle, $sHelpText, $sHelpTextSidebar = "" ) {
         $this->_addHelpText(
-            "<span class='contextual-help-tab-title'>" . $sFieldTitle . "</span> - " . PHP_EOL
+            "<span class='contextual-help-tab-title'>".$sFieldTitle."</span> - ".PHP_EOL
                 . $sHelpText,     
             $sHelpTextSidebar
         );     
@@ -81,7 +81,7 @@ 
     public function _replyToRegisterHelpTabTextForMetaBox() {
 
         // Check if the currently loaded page is of meta box page.
-        if ( ! $this->_isInThePage() ) { return false; }
+        if ( !$this->_isInThePage() ) { return false; }
 
         $this->_setHelpTab(     // defined in the base class.
             $this->oProp->sMetaBoxID, 
@@ -100,11 +100,11 @@ 
      */
     protected function _isInThePage() {
         
-        if ( ! $this->oProp->bIsAdmin ) { return false; }
-        if ( ! in_array( $this->oProp->sPageNow, array( 'post.php', 'post-new.php' ) ) ) {
+        if ( !$this->oProp->bIsAdmin ) { return false; }
+        if ( !in_array( $this->oProp->sPageNow, array( 'post.php', 'post-new.php' ) ) ) {
             return false;
         }
-        if ( ! in_array( $this->oUtil->getCurrentPostType(), $this->oProp->aPostTypes ) ) {
+        if ( !in_array( $this->oUtil->getCurrentPostType(), $this->oProp->aPostTypes ) ) {
             return false;     
         }    
         return true;

development/factory/page_meta_box/_model/AdminPageFramework_Property_MetaBox_Page.php

Doc Comments +4 added lines

@@ -53,6 +53,10 @@
      */
     public $_sFormRegistrationHook = 'admin_enqueue_scripts';
     
+    /**
+     * @param AdminPageFramework_PageMetaBox_Model $oCaller
+     * @param string $sClassName
+     */
     function __construct( $oCaller, $sClassName, $sCapability='manage_options', $sTextDomain='admin-page-framework', $sStructureType='page_meta_box' ) {     
         
         // this must be done after the menu class finishes building the menu with the _replyToBuildMenu() method.

Indentation +1 added lines, -1 removed lines

@@ -170,7 +170,7 @@
      * @since       3.5.3
      * @return      string      The found page slug. An empty string if not found.
      * @remark      Do not return `null` when not found as some framework methods check the retuened value with `isset()` and if null is given, `isset()` yields `false` while it does `true` for an emtpy string (''). 
-    */     
+     */     
     public function getCurrentPageSlug() {
         return isset( $_GET[ 'page' ] ) 
             ? $_GET[ 'page' ] 

Spacing +9 added lines, -9 removed lines

@@ -53,7 +53,7 @@ 
      */
     public $_sFormRegistrationHook = 'admin_enqueue_scripts';
     
-    function __construct( $oCaller, $sClassName, $sCapability='manage_options', $sTextDomain='admin-page-framework', $sStructureType='page_meta_box' ) {     
+    function __construct( $oCaller, $sClassName, $sCapability = 'manage_options', $sTextDomain = 'admin-page-framework', $sStructureType = 'page_meta_box' ) {     
         
         // this must be done after the menu class finishes building the menu with the _replyToBuildMenu() method.
         add_action( 'admin_menu', array( $this, '_replyToSetUpProperties' ), 100 ); 
@@ -91,12 +91,12 @@ 
      */
     public function _replyToSetUpProperties() {
         
-        if ( ! isset( $_GET[ 'page' ] ) ) { 
+        if ( !isset( $_GET[ 'page' ] ) ) { 
             return; 
         }
                 
         $this->oAdminPage = $this->_getOwnerObjectOfPage( $_GET[ 'page' ] );
-        if ( ! $this->oAdminPage ) { 
+        if ( !$this->oAdminPage ) { 
             return; 
         }
         
@@ -127,7 +127,7 @@ 
      */
     public function _getScreenIDOfPage( $sPageSlug ) {
         return ( $_oAdminPage = $this->_getOwnerObjectOfPage( $sPageSlug ) )
-            ? $_oAdminPage->oProp->aPages[ $sPageSlug ][ '_page_hook' ] . ( is_network_admin() ? '-network' : '' )
+            ? $_oAdminPage->oProp->aPages[ $sPageSlug ][ '_page_hook' ].( is_network_admin() ? '-network' : '' )
             : '';
     }    
     
@@ -137,7 +137,7 @@ 
      * @since       3.0.0
      * @return      boolean     Returns true if it is of framework's added page; otherwise, false.
      */
-    public function isPageAdded( $sPageSlug='' ) {    
+    public function isPageAdded( $sPageSlug = '' ) {    
         return ( $_oAdminPage = $this->_getOwnerObjectOfPage( $sPageSlug ) )
             ? $_oAdminPage->oProp->isPageAdded( $sPageSlug )
             : false;
@@ -153,7 +153,7 @@ 
     public function isCurrentTab( $sTabSlug ) {
         
         $_sCurrentPageSlug = $this->getElement( $_GET, 'page' );
-        if ( ! $_sCurrentPageSlug ) { 
+        if ( !$_sCurrentPageSlug ) { 
             return false; 
         }
         $_sCurrentTabSlug = $this->getElement( 
@@ -203,7 +203,7 @@ 
      */         
     public function getDefaultInPageTab( $sPageSlug ) {
     
-        if ( ! $sPageSlug ) { 
+        if ( !$sPageSlug ) { 
             return ''; 
         }
         return ( $_oAdminPage = $this->_getOwnerObjectOfPage( $sPageSlug ) )
@@ -218,7 +218,7 @@ 
      */
     public function getOptionKey( $sPageSlug ) {
         
-        if ( ! $sPageSlug ) { 
+        if ( !$sPageSlug ) { 
             return ''; 
         }
         return ( $_oAdminPage = $this->_getOwnerObjectOfPage( $sPageSlug ) )
@@ -244,7 +244,7 @@ 
             $GLOBALS,
             array( 'aAdminPageFramework', 'aPageClasses' )
         );                 
-        foreach( $_aPageClasses as $_oAdminPage ) {
+        foreach ( $_aPageClasses as $_oAdminPage ) {
             if ( $_oAdminPage->oProp->isPageAdded( $sPageSlug ) ) {
                 return $_oAdminPage;
             }

Braces +8 added lines, -8 removed lines

@@ -53,11 +53,11 @@ 
      */
     public $_sFormRegistrationHook = 'admin_enqueue_scripts';
     
-    function __construct( $oCaller, $sClassName, $sCapability='manage_options', $sTextDomain='admin-page-framework', $sStructureType='page_meta_box' ) {     
+    function __construct( $oCaller, $sClassName, $sCapability='manage_options', $sTextDomain='admin-page-framework', $sStructureType='page_meta_box' ) {
         
         // this must be done after the menu class finishes building the menu with the _replyToBuildMenu() method.
         add_action( 'admin_menu', array( $this, '_replyToSetUpProperties' ), 100 ); 
-        if ( is_network_admin() ) { 
+        if ( is_network_admin() ) {
             add_action( 'network_admin_menu', array( $this, '_replyToSetUpProperties' ), 100 ); 
         }     
         
@@ -91,12 +91,12 @@ 
      */
     public function _replyToSetUpProperties() {
         
-        if ( ! isset( $_GET[ 'page' ] ) ) { 
+        if ( ! isset( $_GET[ 'page' ] ) ) {
             return; 
         }
                 
         $this->oAdminPage = $this->_getOwnerObjectOfPage( $_GET[ 'page' ] );
-        if ( ! $this->oAdminPage ) { 
+        if ( ! $this->oAdminPage ) {
             return; 
         }
         
@@ -137,7 +137,7 @@ 
      * @since       3.0.0
      * @return      boolean     Returns true if it is of framework's added page; otherwise, false.
      */
-    public function isPageAdded( $sPageSlug='' ) {    
+    public function isPageAdded( $sPageSlug='' ) {
         return ( $_oAdminPage = $this->_getOwnerObjectOfPage( $sPageSlug ) )
             ? $_oAdminPage->oProp->isPageAdded( $sPageSlug )
             : false;
@@ -153,7 +153,7 @@ 
     public function isCurrentTab( $sTabSlug ) {
         
         $_sCurrentPageSlug = $this->getElement( $_GET, 'page' );
-        if ( ! $_sCurrentPageSlug ) { 
+        if ( ! $_sCurrentPageSlug ) {
             return false; 
         }
         $_sCurrentTabSlug = $this->getElement( 
@@ -203,7 +203,7 @@ 
      */         
     public function getDefaultInPageTab( $sPageSlug ) {
     
-        if ( ! $sPageSlug ) { 
+        if ( ! $sPageSlug ) {
             return ''; 
         }
         return ( $_oAdminPage = $this->_getOwnerObjectOfPage( $sPageSlug ) )
@@ -218,7 +218,7 @@ 
      */
     public function getOptionKey( $sPageSlug ) {
         
-        if ( ! $sPageSlug ) { 
+        if ( ! $sPageSlug ) {
             return ''; 
         }
         return ( $_oAdminPage = $this->_getOwnerObjectOfPage( $sPageSlug ) )