michaeluno / admin-page-framework

development/factory/admin_page/_model/AdminPageFramework_CustomSubmitFields.php

Spacing +4 added lines, -4 removed lines

@@ -35,7 +35,7 @@ 
     public function __construct( array $aPostElement ) {
 
         $this->aPost    = $aPostElement;
-        $this->sInputID = $this->getInputID( $aPostElement['submit'] ); // the submit element must be set by the field type.
+        $this->sInputID = $this->getInputID( $aPostElement[ 'submit' ] ); // the submit element must be set by the field type.
 
     }
 
@@ -47,10 +47,10 @@ 
      * @since   2.0.0
      * @since   3.4.0   Changed the name from `getElement()`.
      */
-    protected function getSubmitValueByType( $aElement, $sInputID, $sElementKey='format' ) {
+    protected function getSubmitValueByType( $aElement, $sInputID, $sElementKey = 'format' ) {
 
         return $this->getElement(
-            $aElement,  // subject array
+            $aElement, // subject array
             array( $sInputID, $sElementKey ), // dimensional keys
             null    // default
         );
@@ -80,7 +80,7 @@ 
         // Only the pressed element will be stored in the array.
         // The input tag: name="__import[submit][my_section_my_import_field_the_index]" value="Import Button"
         // The array structure:  array( 'my_section_my_import_field_the_index' => 'Import Button' )
-        foreach( $aSubmitElement as $sInputID => $v ) { // $aSubmitElement should have been set in the constructor.
+        foreach ( $aSubmitElement as $sInputID => $v ) { // $aSubmitElement should have been set in the constructor.
             $this->sInputID = $sInputID;
             return $this->sInputID;
         }

Braces +2 added lines, -1 removed lines

@@ -80,7 +80,8 @@
         // Only the pressed element will be stored in the array.
         // The input tag: name="__import[submit][my_section_my_import_field_the_index]" value="Import Button"
         // The array structure:  array( 'my_section_my_import_field_the_index' => 'Import Button' )
-        foreach( $aSubmitElement as $sInputID => $v ) { // $aSubmitElement should have been set in the constructor.
+        foreach( $aSubmitElement as $sInputID => $v ) {
+// $aSubmitElement should have been set in the constructor.
             $this->sInputID = $sInputID;
             return $this->sInputID;
         }

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

Spacing +3 added lines, -3 removed lines

@@ -63,7 +63,7 @@ 
             )
         );
 
-        if ( ! $this->_isEnabled( $_aTab ) ) {
+        if ( !$this->_isEnabled( $_aTab ) ) {
             return array();
         }
 
@@ -77,7 +77,7 @@ 
                 : esc_url(
                     $this->getElement(
                         $_aTab,
-                        'url',  // if the 'url' argument is set, use it. Otherwise, use the below gnerated url.
+                        'url', // if the 'url' argument is set, use it. Otherwise, use the below gnerated url.
                         $this->getQueryAdminURL(
                             array(
                                 'page'  => $this->aArguments[ 'page_slug' ],
@@ -106,7 +106,7 @@ 
          * @return      boolean
          */
         private function _isEnabled( $aTab ) {
-            return ! in_array(
+            return !in_array(
                 false,
                 array(
                     ( bool ) current_user_can( $aTab[ 'capability' ] ), // whether the user has the sufficient capability level

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

Spacing +5 added lines, -5 removed lines

@@ -23,12 +23,12 @@ 
      * @static
      */
     static public $aStructure = array(
-        'src'           => null,    // (required, string) the source url or path
+        'src'           => null, // (required, string) the source url or path
         'handle_id'     => null,
         'dependencies'  => array(),
-        'version'       => false,       // although the type should be string, the wp_enqueue_...() functions want false as the default value.
-        'translation'   => array(),     // only for scripts
-        'in_footer'     => false,       // only for scripts
+        'version'       => false, // although the type should be string, the wp_enqueue_...() functions want false as the default value.
+        'translation'   => array(), // only for scripts
+        'in_footer'     => false, // only for scripts
         // 'attributes'    => null,    // (optional, array) [3.3.0+] attributes array. `array( 'data-id' => '...' )`
     );
 
@@ -41,7 +41,7 @@ 
         $_aParameters = func_get_args() + array(
             $this->asSubject,
         );
-        $this->asSubject             = $_aParameters[ 0 ];
+        $this->asSubject = $_aParameters[ 0 ];
     }
 
     /**

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

Spacing +6 added lines, -6 removed lines

@@ -23,11 +23,11 @@ 
      * @static
      */
     static public $aStructure = array(
-        'src'           => null,    // (required, string) the source url or path
-        'handle_id'     => null,    // (optional, string) The handle ID of the stylesheet
-        'dependencies'  => null,    // (optional, array) The dependency array.
-        'version'       => null,    // (optional, string) The stylesheet version number.
-        'media'         => null,    // (optional, string) the description of the field which is inserted into the after the input field tag.
+        'src'           => null, // (required, string) the source url or path
+        'handle_id'     => null, // (optional, string) The handle ID of the stylesheet
+        'dependencies'  => null, // (optional, array) The dependency array.
+        'version'       => null, // (optional, string) The stylesheet version number.
+        'media'         => null, // (optional, string) the description of the field which is inserted into the after the input field tag.
         // 'attributes'    => null,    // (optional, array) [3.3.0+] attributes array. `array( 'data-id' => '...' )`
     );
 
@@ -40,7 +40,7 @@ 
         $_aParameters = func_get_args() + array(
             $this->asSubject,
         );
-        $this->asSubject             = $_aParameters[ 0 ];
+        $this->asSubject = $_aParameters[ 0 ];
     }
 
     /**

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

Indentation -1 removed lines

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

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

Spacing +7 added lines, -7 removed lines

@@ -31,8 +31,8 @@ 
         'page_slug'                 => null, // (required)
         'type'                      => 'page', // this is used to compare with the link type.
         'title'                     => null,
-        'page_title'                => null,    // (optional) 3.3.0+ When the page title is different from the above 'title' argument, set this.
-        'menu_title'                => null,    // (optional) 3.3.0+ When the menu title is different from the above 'title' argument, set this.
+        'page_title'                => null, // (optional) 3.3.0+ When the page title is different from the above 'title' argument, set this.
+        'menu_title'                => null, // (optional) 3.3.0+ When the menu title is different from the above 'title' argument, set this.
         'screen_icon'               => null, // this will become either href_icon_32x32 or screen_icon_id
         'capability'                => null,
         'order'                     => null,
@@ -123,12 +123,12 @@ 
 
             $aSubMenuPage = $aSubMenuPage
                 + array(
-                    'show_page_title'           => $this->oFactory->oProp->bShowPageTitle,       // boolean
+                    'show_page_title'           => $this->oFactory->oProp->bShowPageTitle, // boolean
                     'show_page_heading_tabs'    => $this->oFactory->oProp->bShowPageHeadingTabs, // boolean
-                    'show_in_page_tabs'         => $this->oFactory->oProp->bShowInPageTabs,      // boolean
-                    'in_page_tab_tag'           => $this->oFactory->oProp->sInPageTabTag,        // string
-                    'page_heading_tab_tag'      => $this->oFactory->oProp->sPageHeadingTabTag,   // string
-                    'capability'                => $this->oFactory->oProp->sCapability,  // 3.6.0+
+                    'show_in_page_tabs'         => $this->oFactory->oProp->bShowInPageTabs, // boolean
+                    'in_page_tab_tag'           => $this->oFactory->oProp->sInPageTabTag, // string
+                    'page_heading_tab_tag'      => $this->oFactory->oProp->sPageHeadingTabTag, // string
+                    'capability'                => $this->oFactory->oProp->sCapability, // 3.6.0+
                 )
                 + self::$aStructure;
 

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

Spacing +9 added lines, -9 removed lines

@@ -30,15 +30,15 @@
         'page_slug'         => null,
         'tab_slug'          => null,
         'title'             => null,
-        'order'             => 10,      // (integer)
-        'show_in_page_tab'  => true,    // 3.6.0+ (boolean)
-        'parent_tab_slug'   => null,    // this needs to be set if the above show_in_page_tab is false so that the framework can mark the parent tab to be active when the hidden page is accessed.
-        'url'               => null,    // 3.5.0+ This allows the user set custom link.
-        'disabled'          => null,    // 3.5.10+ (boolean) If true, the link will be unlinked.
-        'attributes'        => null,    // 3.5.10+ (array) Applies to the navigation tab bar element.
-        'capability'        => null,    // 3.6.0+ (string)
-        'if'                => true,    // 3.6.0+ (boolean)
-        'show_debug_info'   => null,    // 3.8.8+ (boolean, optional) Whether to show debug information. If not set, the existent `bShowDebugInfo` property value will be used. The initial value here is `null` as the default value will be assigned in the formatting method.
+        'order'             => 10, // (integer)
+        'show_in_page_tab'  => true, // 3.6.0+ (boolean)
+        'parent_tab_slug'   => null, // this needs to be set if the above show_in_page_tab is false so that the framework can mark the parent tab to be active when the hidden page is accessed.
+        'url'               => null, // 3.5.0+ This allows the user set custom link.
+        'disabled'          => null, // 3.5.10+ (boolean) If true, the link will be unlinked.
+        'attributes'        => null, // 3.5.10+ (array) Applies to the navigation tab bar element.
+        'capability'        => null, // 3.6.0+ (string)
+        'if'                => true, // 3.6.0+ (boolean)
+        'show_debug_info'   => null, // 3.8.8+ (boolean, optional) Whether to show debug information. If not set, the existent `bShowDebugInfo` property value will be used. The initial value here is `null` as the default value will be assigned in the formatting method.
     );
 
     /**

development/factory/admin_page/_model/AdminPageFramework_Property_admin_page.php

Spacing +14 added lines, -14 removed lines

@@ -217,7 +217,7 @@ 
      */
     public $aDisallowedQueryKeys = array(
         'settings-updated',
-        'confirmation',     // 3.3.0+
+        'confirmation', // 3.3.0+
         'field_errors'      // 3.4.1+
     );
 
@@ -263,7 +263,7 @@ 
      * Stores the cache lifetime of the transient used for the form options when the user passes an integer to the option key parameter.
      * @since       3.5.9
      */
-    public $iOptionTransientDuration  = 0;
+    public $iOptionTransientDuration = 0;
 
     /**
      * Constructs the instance of AdminPageFramework_Property_admin_page class object.
@@ -272,10 +272,10 @@ 
      * @since       2.0.0
      * @since       2.1.5   The $oCaller parameter was added.
      */
-    public function __construct( $oCaller, $sCallerPath, $sClassName, $aisOptionKey, $sCapability='manage_options', $sTextDomain='admin-page-framework' ) {
+    public function __construct( $oCaller, $sCallerPath, $sClassName, $aisOptionKey, $sCapability = 'manage_options', $sTextDomain = 'admin-page-framework' ) {
 
         // 3.7.0+ This must be set before the parent constructor. As the form arguments array uses this value.
-        $this->_sFormRegistrationHook = 'load_after_' . $sClassName;
+        $this->_sFormRegistrationHook = 'load_after_'.$sClassName;
 
         parent::__construct(
             $oCaller,
@@ -351,7 +351,7 @@ 
                 }
                 // The user want to save options in a transient.
                 if ( in_array( $_sType, array( 'integer' ) ) ) {
-                    return 'apf_' . md5( site_url() . '_' . $sClassName . '_' . get_current_user_id() );
+                    return 'apf_'.md5( site_url().'_'.$sClassName.'_'.get_current_user_id() );
                 }
 
                 // Unknown type - maybe the user is trying to do something advanced.
@@ -378,7 +378,7 @@ 
          */
         protected function _isAdminPage() {
 
-            if ( ! is_admin() ) {
+            if ( !is_admin() ) {
                 return false;
             }
             return isset( $_GET[ 'page' ] );
@@ -418,7 +418,7 @@ 
                 case 'transient':
                     return $this->getAsArray(
                         $this->getTransient(
-                            $this->sOptionKey,  // transient key
+                            $this->sOptionKey, // transient key
                             array() // default
                         )
                     );
@@ -432,7 +432,7 @@ 
      * @since       3.1.1       Made it return a value.
      * @return      boolean     True if saved; otherwise, false.
      */
-    public function updateOption( $aOptions=null ) {
+    public function updateOption( $aOptions = null ) {
 
         if ( $this->_bDisableSavingOptions ) {
             return false;
@@ -460,7 +460,7 @@ 
                     );
                 case 'transient':
                     return $this->setTransient(
-                        $this->sOptionKey,  // transient key
+                        $this->sOptionKey, // transient key
                         $aOptions,
                         $this->iOptionTransientDuration
                     );
@@ -475,7 +475,7 @@ 
      * @since       2.1.0       Set the default value to the parameter and if the parameter value is empty, it applies the current $_GET[ 'page' ] value.
      * @return      boolean     Returns true if it is of framework's added page; otherwise, false.
      */
-    public function isPageAdded( $sPageSlug='' ) {
+    public function isPageAdded( $sPageSlug = '' ) {
 
         $sPageSlug = trim( $sPageSlug );
         $sPageSlug = $sPageSlug
@@ -512,7 +512,7 @@ 
      * @return      string      The found tab slug. An empty string if not found.
      * @remark      Do not return `null` when not found as some framework methods check the returned value with `isset()` and if null is given, `isset()` yields `false` while it does `true` for an empty string ('').
      */
-    public function getCurrentTabSlug( $sCurrentPageSlug='' ) {
+    public function getCurrentTabSlug( $sCurrentPageSlug = '' ) {
 
         // It is possible that the tab slug is not set if it is the default tab.
         $_sTabSlug = $this->getElement( $this->aQuery, 'tab', '' );
@@ -532,7 +532,7 @@ 
          *
          * @deprecated  3.5.3
          */
-        public function getCurrentTab( $sCurrentPageSlug='' ) {
+        public function getCurrentTab( $sCurrentPageSlug = '' ) {
             return $this->getCurrentTabSlug( $sCurrentPageSlug );
         }
 
@@ -547,11 +547,11 @@ 
      */
     public function getDefaultInPageTab( $sPageSlug ) {
 
-        if ( ! $sPageSlug ) {
+        if ( !$sPageSlug ) {
             return '';
         }
         return $this->getElement(
-            $this->aDefaultInPageTabs,  // subject array
+            $this->aDefaultInPageTabs, // subject array
             $sPageSlug, // key
             ''    // default
         );

development/factory/admin_page/AdminPageFramework_Model_Form.php

Spacing +17 added lines, -17 removed lines

@@ -58,7 +58,7 @@ 
      * @since       3.3.0
      * @since       3.3.1       Moved from `AdminPageFramework_Setting_Base`.
      */
-    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 );
 
@@ -66,7 +66,7 @@ 
 //        if ( $this->oProp->bIsAdminAjax ) {
 //            return;
 //        }
-        if ( ! $this->oProp->bIsAdmin ) {
+        if ( !$this->oProp->bIsAdmin ) {
             return;
         }
 
@@ -116,7 +116,7 @@ 
             'section_title' => null,
             'section_id'    => null,
         );
-        if ( ! $aFieldset[ 'help' ] ) {
+        if ( !$aFieldset[ 'help' ] ) {
             return;
         }
 
@@ -134,7 +134,7 @@ 
                 'help_tab_id'               => $_sRootSectionID,
                 'help_tab_content'          => "<span class='contextual-help-tab-title'>"
                         . $aFieldset[ 'title' ]
-                    . "</span> - " . PHP_EOL
+                    . "</span> - ".PHP_EOL
                     . $aFieldset[ 'help' ],
                 'help_tab_sidebar_content'  => $aFieldset[ 'help_aside' ]
                     ? $aFieldset[ 'help_aside' ]
@@ -168,7 +168,7 @@ 
         public function _registerHelpPaneItemsOfFormSections( $aSectionsets ) {
 // @todo Test if help pane item gets displayed
 
-            foreach( $aSectionsets as $_aSectionset ) {
+            foreach ( $aSectionsets as $_aSectionset ) {
 // @todo check capability and conditions
                 $_aSectionset = $_aSectionset + array(
                     'help'          => null,
@@ -202,13 +202,13 @@ 
      */
     public function _replyToDetermineSectionsetVisibility( $bVisible, $aSectionset ) {
 
-        if ( ! current_user_can( $aSectionset[ 'capability' ] ) ) {
+        if ( !current_user_can( $aSectionset[ 'capability' ] ) ) {
             return false;
         }
-        if ( ! $aSectionset[ 'if' ] ) {
+        if ( !$aSectionset[ 'if' ] ) {
             return false;
         }
-        if ( ! $this->_isSectionOfCurrentPage( $aSectionset ) ) {
+        if ( !$this->_isSectionOfCurrentPage( $aSectionset ) ) {
             return false;
         }
         return $bVisible;
@@ -226,15 +226,15 @@ 
         private function _isSectionOfCurrentPage( array $aSectionset ) {
 
             // Make sure the value type is string so that when the page_slug is not set, it won't match.
-            $_sCurrentPageSlug  = ( string ) $this->oProp->getCurrentPageSlug();
+            $_sCurrentPageSlug = ( string ) $this->oProp->getCurrentPageSlug();
 
             // Make sure if it's in the loading page.
-            if ( $aSectionset[ 'page_slug' ] !== $_sCurrentPageSlug  ) {
+            if ( $aSectionset[ 'page_slug' ] !== $_sCurrentPageSlug ) {
                 return false;
             }
 
             // If no tag is specified, the user wants to display the section regardless of the tab.
-            if ( ! $aSectionset[ 'tab_slug' ] ) {
+            if ( !$aSectionset[ 'tab_slug' ] ) {
                 return true;
             }
 
@@ -250,7 +250,7 @@ 
      */
     public function _replyToDetermineFieldsetVisibility( $bVisible, $aFieldset ) {
 
-        $_sCurrentPageSlug  = $this->oProp->getCurrentPageSlug();
+        $_sCurrentPageSlug = $this->oProp->getCurrentPageSlug();
 
         // If the specified field does not exist, do nothing.
         if ( $aFieldset[ 'page_slug' ] !== $_sCurrentPageSlug ) {
@@ -280,7 +280,7 @@ 
             array( $_sSectionPath, 'page_slug' ),
             $this->oProp->getCurrentPageSlugIfAdded()
         );
-        $aFieldset[ 'tab_slug' ]        = $this->oUtil->getElement(
+        $aFieldset[ 'tab_slug' ] = $this->oUtil->getElement(
             $aSectionsets,
             array( $_sSectionPath, 'tab_slug' ),
             $this->oProp->getCurrentInPageTabSlugIfAdded()
@@ -291,11 +291,11 @@ 
             $aSectionsets,
             $_sSectionPath
         );
-        $aFieldset[ 'section_title' ]   = $this->oUtil->getElement(
+        $aFieldset[ 'section_title' ] = $this->oUtil->getElement(
             $_aSectionset,
             'title'
         );
-        $aFieldset[ 'capability' ]   = $aFieldset[ 'capability' ]
+        $aFieldset[ 'capability' ] = $aFieldset[ 'capability' ]
             ? $aFieldset[ 'capability' ]
             : $this->_replyToGetCapabilityForForm(
                 $this->oUtil->getElement( $_aSectionset, 'capability' ),
@@ -345,13 +345,13 @@ 
 
             // Find the capability of the parent section if nested.
             if ( 0 < $aSectionset[ '_nested_depth' ] ) {
-                $_aSectionPath         = $aSectionset[ '_section_path_array' ];
+                $_aSectionPath = $aSectionset[ '_section_path_array' ];
                 array_pop( $_aSectionPath ); // remove the last element
                 $_sParentCapability = $this->oUtil->getElement(
                     $this->oForm->aSectionsets,
                     array_merge( $_aSectionPath, array( 'capability' ) )
                 );
-                if( $_sParentCapability ) {
+                if ( $_sParentCapability ) {
                     return $_sParentCapability;
                 }
             }