michaeluno / admin-page-framework

development/factory/admin_page/_model/AdminPageFramework_ImportOptions.php

Doc Comments +5 added lines

@@ -89,6 +89,11 @@
         return $vData;
         
     }
+
+    /**
+     * @param string $vData
+     * @param string $sFormatType
+     */
     public function formatImportData( &$vData, $sFormatType=null ) {
         
         $sFormatType = isset( $sFormatType ) ? $sFormatType : $this->getFormatType();

Spacing +3 added lines, -3 removed lines

@@ -56,11 +56,11 @@ 
 
     }
 
-    private function getElementInFilesArray( array $aFilesImport, $sInputID, $sElementKey='error' ) {
+    private function getElementInFilesArray( array $aFilesImport, $sInputID, $sElementKey = 'error' ) {
 
         $sElementKey = strtolower( $sElementKey );
         return $this->getElement(
-            $aFilesImport,  // subject array
+            $aFilesImport, // subject array
             array( $sElementKey, $sInputID ), // dimensional keys
             null    // default
         );
@@ -88,7 +88,7 @@ 
         return $vData;
 
     }
-    public function formatImportData( &$vData, $sFormatType=null ) {
+    public function formatImportData( &$vData, $sFormatType = null ) {
 
         $sFormatType = isset( $sFormatType ) ? $sFormatType : $this->getFormatType();
         switch ( strtolower( $sFormatType ) ) {

development/factory/admin_page/_model/delegate/AdminPageFramework_Model__FormEmailHandler.php

Doc Comments +1 added lines

@@ -25,6 +25,7 @@
     /**
      * Sets up properties.
      * @since       3.6.3
+     * @param AdminPageFramework_Model_Form $oFactory
      */
     public function __construct( $oFactory ) {
        

Spacing +4 added lines, -4 removed lines

@@ -29,10 +29,10 @@ 
      */
     public function __construct( $oFactory ) {
        
-        $this->oFactory         = $oFactory;
+        $this->oFactory = $oFactory;
 
         // Form emails.
-        if ( ! isset( $_GET[ 'apf_action' ], $_GET[ 'transient' ] ) ) {
+        if ( !isset( $_GET[ 'apf_action' ], $_GET[ 'transient' ] ) ) {
             return;
         }
         if ( 'email' !== $_GET[ 'apf_action' ] ) {
@@ -74,12 +74,12 @@ 
             self::$_bDoneEmail = true;
 
             $_sTransient = $this->getElement( $_GET, 'transient', '' );
-            if ( ! $_sTransient ) {
+            if ( !$_sTransient ) {
                 return;
             }
             $_aFormEmail = $this->getTransient( $_sTransient );
             $this->deleteTransient( $_sTransient );
-            if ( ! is_array( $_aFormEmail ) ) {
+            if ( !is_array( $_aFormEmail ) ) {
                 return;
             }
 

development/factory/admin_page/_model/delegate/AdminPageFramework_Model__FormSubmission.php

Doc Comments +6 added lines

@@ -26,6 +26,7 @@ 
     /**
      * Sets up hooks and properties.
      * @since       3.6.3
+     * @param AdminPageFramework_Model_Form $oFactory
      */
     public function __construct( $oFactory, $aSavedData, $aArguments, $aSectionsets, $aFieldsets ) {
        
@@ -250,6 +251,9 @@ 
          * Do the 'submit_...' actions.
          * 
          * @internal
+         * @param null|string $_sSubmitSectionID
+         * @param null|string $_sPressedFieldID
+         * @param null|string $_sPressedInputID
          * @return      void
          * @since       3.5.3
          * @since       3.6.3       Moved from `AdminPageFramework_Validation`.
@@ -296,6 +300,8 @@ 
          * Do the 'submit_after_...' actions.
          * 
          * @internal
+         * @param null|string $_sSubmitSectionID
+         * @param null|string $_sPressedFieldID
          * @return      void
          * @since       3.5.3
          * @since       3.6.3       Moved from `AdminPageFramework_Validation`.

Braces +4 added lines, -3 removed lines

@@ -138,7 +138,7 @@ 
         
         // Save the data.
         $_bUpdated = false;
-        if ( ! $this->oFactory->oProp->_bDisableSavingOptions ) {  
+        if ( ! $this->oFactory->oProp->_bDisableSavingOptions ) {
             $_bUpdated = $this->oFactory->oProp->updateOption( $_aInputs );
         }
 
@@ -181,14 +181,15 @@ 
                     $_POST[ 'admin_page_framework_start' ], // indicates the framework form is started
                     $_POST[ '_wp_http_referer' ]
                 ) 
-            ) {     
+            ) {
                 return false;
             }
             
             // Referrer
             $_sRequestURI   = remove_query_arg( array( 'settings-updated', 'confirmation', 'field_errors' ), wp_unslash( $_SERVER[ 'REQUEST_URI' ] ) );
             $_sReffererURI  = remove_query_arg( array( 'settings-updated', 'confirmation', 'field_errors' ), $_POST[ '_wp_http_referer' ] );
-            if ( $_sRequestURI != $_sReffererURI ) { // see the function definition of wp_referer_field() in functions.php.
+            if ( $_sRequestURI != $_sReffererURI ) {
+// see the function definition of wp_referer_field() in functions.php.
                 return false;
             }
             

Spacing +12 added lines, -12 removed lines

@@ -29,7 +29,7 @@ 
      */
     public function __construct( $oFactory, $aSavedData, $aArguments, $aSectionsets, $aFieldsets ) {
        
-        $this->oFactory         = $oFactory;        
+        $this->oFactory = $oFactory;        
                 
         // add_action
         // @deprecated      3.7.0
@@ -72,7 +72,7 @@ 
      */    
     public function _handleFormData() {
         
-        if ( ! $this->_shouldProceed() ) {
+        if ( !$this->_shouldProceed() ) {
             return;
         }
 
@@ -127,7 +127,7 @@ 
         new AdminPageFramework_Model__FormSubmission__Validator( $this->oFactory );
         
         // [3.6.3+] Apply filters. All the sub-routines of handling form submit data use this filter hook.
-        $_aInputs    = $this->addAndApplyFilters(    
+        $_aInputs = $this->addAndApplyFilters(    
             $this->oFactory, 
             "validation_pre_{$this->oFactory->oProp->sClassName}", 
             $_aInputs,
@@ -138,7 +138,7 @@ 
 
         // Save the data.
         $_bUpdated = false;
-        if ( ! $this->oFactory->oProp->_bDisableSavingOptions ) {  
+        if ( !$this->oFactory->oProp->_bDisableSavingOptions ) {  
             $_bUpdated = $this->oFactory->oProp->updateOption( $_aInputs );
         }
 
@@ -177,7 +177,7 @@ 
         private function _shouldProceed() {
             
             if ( 
-                ! isset( 
+                !isset( 
                     $_POST[ 'admin_page_framework_start' ], // indicates the framework form is started
                     $_POST[ '_wp_http_referer' ]
                 ) 
@@ -194,7 +194,7 @@ 
             
             // Check if all the form fields are sent. 
             if (
-                ! isset(
+                !isset(
                     // these keys are supposed to be embedded at the end of the form.
                     // if the server truncates the form input values for `max_input_vars`, these will be lost in PHP 5.3.9 or above.
                     $_POST[ '_is_admin_page_framework' ], // holds the form nonce
@@ -214,7 +214,7 @@ 
                 return false;
             }
                         
-            $_sNonceTransientKey = 'form_' . md5( $this->oFactory->oProp->sClassName . get_current_user_id() );
+            $_sNonceTransientKey = 'form_'.md5( $this->oFactory->oProp->sClassName.get_current_user_id() );
             if ( $_POST[ '_is_admin_page_framework' ] !== $this->getTransient( $_sNonceTransientKey ) ) {
                 $this->oFactory->setAdminNotice( $this->oFactory->oMsg->get( 'nonce_verification_failed' ) );
                 return false;
@@ -232,7 +232,7 @@ 
          */
         private function _getUserInputsFromPOST() {
 
-            $_aInputs     = $this->getElementAsArray( 
+            $_aInputs = $this->getElementAsArray( 
                 $_POST, 
                 $this->oFactory->oProp->sOptionKey, 
                 array() 
@@ -267,7 +267,7 @@ 
                 $this->oFactory,
                 array( 
                     // @todo deprecate the hook with the input ID
-                    "submit_{$this->oFactory->oProp->sClassName}_{$_sPressedInputID}",  // will be deprecated in near future release
+                    "submit_{$this->oFactory->oProp->sClassName}_{$_sPressedInputID}", // will be deprecated in near future release
                     $_sSubmitSectionID 
                         ? "submit_{$this->oFactory->oProp->sClassName}_{$_sSubmitSectionID}_{$_sPressedFieldID}" 
                         : "submit_{$this->oFactory->oProp->sClassName}_{$_sPressedFieldID}",
@@ -350,9 +350,9 @@ 
             
             // Drop the 'field_errors' key.
             $_aRemoveQueries = array();
-            if ( ! isset( $aStatus[ 'field_errors' ] ) || ! $aStatus[ 'field_errors' ] ) {
+            if ( !isset( $aStatus[ 'field_errors' ] ) || !$aStatus[ 'field_errors' ] ) {
                 unset( $aStatus[ 'field_errors' ] );
-                $_aRemoveQueries[] = 'field_errors';
+                $_aRemoveQueries[ ] = 'field_errors';
             }        
          
             return $this->addAndApplyFilters(    // 3.4.4+
@@ -377,7 +377,7 @@ 
          */
         private function _removePageElements( $aOptions, $sPageSlug, $sTabSlug ) {
             
-            if ( ! $sPageSlug && ! $sTabSlug ) {
+            if ( !$sPageSlug && !$sTabSlug ) {
                 return $aOptions;
             }
             

development/factory/admin_page/_model/delegate/AdminPageFramework_Model__FormSubmission_Base.php

Doc Comments +1 added lines

@@ -79,6 +79,7 @@
      * @since       3.5.3
      * @since       3.6.3       Moved from `AdminPageFramework_Form_Model_Validation_Option`.
      * @internal
+     * @param boolean $bIsInputEmtpy
      * @return      void
      * @remark      Accessed from some of the parent/child classes.
      */

Spacing +3 added lines, -3 removed lines

@@ -46,12 +46,12 @@
      * @return      null|string     Returns `null` if no value is found and the associated link url if found. 
      * Otherwise, the found value.
      */ 
-    protected function _getPressedSubmitButtonData( array $aPostElements, $sTargetKey='field_id' ) {    
+    protected function _getPressedSubmitButtonData( array $aPostElements, $sTargetKey = 'field_id' ) {    
 
-        foreach( $aPostElements as $_sInputID => $_aSubElements ) {
+        foreach ( $aPostElements as $_sInputID => $_aSubElements ) {
             
             // The 'name' key must be set.
-            if ( ! isset( $_aSubElements[ 'name' ] ) ) {
+            if ( !isset( $_aSubElements[ 'name' ] ) ) {
                 continue;
             }
             $_aNameKeys = explode( '|', $_aSubElements[ 'name' ] ); 

Braces +2 added lines, -2 removed lines

@@ -46,7 +46,7 @@ 
      * @return      null|string     Returns `null` if no value is found and the associated link url if found. 
      * Otherwise, the found value.
      */ 
-    protected function _getPressedSubmitButtonData( array $aPostElements, $sTargetKey='field_id' ) {    
+    protected function _getPressedSubmitButtonData( array $aPostElements, $sTargetKey='field_id' ) {
 
         foreach( $aPostElements as $_sInputID => $_aSubElements ) {
             
@@ -84,7 +84,7 @@ 
      */
     protected function _setSettingNoticeAfterValidation( $bIsInputEmtpy ) {
      
-        if ( $this->oFactory->hasSettingNotice() ) {     
+        if ( $this->oFactory->hasSettingNotice() ) {
             return;
         }
         $this->oFactory->setSettingNotice(  

development/factory/admin_page/_view/AdminPageFramework_View__PageRenderer.php

Doc Comments +1 added lines

@@ -28,6 +28,7 @@
     /**
      * Sets up properties.
      * @since       3.6.3
+     * @param AdminPageFramework_View_Page $oFactory
      */
     public function __construct( $oFactory, $sPageSlug, $sTabSlug ) {
        

Spacing +21 added lines, -21 removed lines

@@ -47,7 +47,7 @@ 
 
         // Do actions before rendering the page. In this order, global -> page -> in-page tab
         $this->addAndDoActions(
-            $this->oFactory,  // the caller object
+            $this->oFactory, // the caller object
             $this->getFilterArrayByPrefix( 'do_before_', $this->oFactory->oProp->sClassName, $_sPageSlug, $_sTabSlug, true ), // the action hooks
             $this->oFactory   // the argument 1
         );
@@ -72,7 +72,7 @@ 
                     </div><!-- #post-body -->
                 </div><!-- #poststuff -->
 
-            <?php echo $this->_printFormClosingTag( $_sPageSlug, $_sTabSlug, $this->oFactory->oProp->bEnableForm );  // </form> ?>
+            <?php echo $this->_printFormClosingTag( $_sPageSlug, $_sTabSlug, $this->oFactory->oProp->bEnableForm ); // </form> ?>
             </div><!-- .admin-page-framework-container -->
 
             <?php
@@ -83,7 +83,7 @@ 
         <?php
         // Do actions after rendering the page.
         $this->addAndDoActions(
-            $this->oFactory,  // the caller object
+            $this->oFactory, // the caller object
             $this->getFilterArrayByPrefix( 'do_after_', $this->oFactory->oProp->sClassName, $_sPageSlug, $_sTabSlug, true ), // the action hooks
             $this->oFactory   // the argument 1
         );
@@ -100,14 +100,14 @@ 
          */
         private function _getNumberOfColumns() {
 
-            if ( ! $this->doesMetaBoxExist( 'side' ) ) {
+            if ( !$this->doesMetaBoxExist( 'side' ) ) {
                 return 1;
             }
 
             $_iColumns = $this->getNumberOfScreenColumns();
             return $_iColumns
                 ? $_iColumns
-                : 1;    // default - this is because generic pages do not have meta boxes.
+                : 1; // default - this is because generic pages do not have meta boxes.
         }
             // @deprecated
             // Make sure if no side meta box exists, set it 1.
@@ -126,7 +126,7 @@ 
         private function _getContentTop() {
 
             // Screen icon, page heading tabs(page title), and in-page tabs.
-            $_oScreenIcon       = new AdminPageFramework_View__PageRenderer__ScreenIcon(
+            $_oScreenIcon = new AdminPageFramework_View__PageRenderer__ScreenIcon(
                 $this->oFactory,
                 $this->sPageSlug,
                 $this->sTabSlug
@@ -142,7 +142,7 @@ 
                 $this->oFactory,
                 $this->sPageSlug
             );
-            $_sContentTop      .= $_oInPageTabs->get();
+            $_sContentTop .= $_oInPageTabs->get();
 
             // Apply filters in this order, in-page tab -> page -> global.
             return $this->addAndApplyFilters(
@@ -214,7 +214,7 @@ 
              */
             private function _getFormOutput( $sPageSlug ) {
 
-                if ( ! $this->oFactory->oProp->bEnableForm ) {
+                if ( !$this->oFactory->oProp->bEnableForm ) {
                     return '';
                 }
                 return $this->oFactory->oForm->get();
@@ -244,9 +244,9 @@ 
          * @internal
          * @return      void
          */
-        private function _printFormOpeningTag( $fEnableForm=true ) {
+        private function _printFormOpeningTag( $fEnableForm = true ) {
 
-            if ( ! $fEnableForm ) {
+            if ( !$fEnableForm ) {
                 return;
             }
 
@@ -259,12 +259,12 @@ 
                             'action'    => wp_unslash( remove_query_arg( 'settings-updated', $this->oFactory->oProp->sTargetFormPage ) ),
                         )
                     )
-                . " >" . PHP_EOL;
+                . " >".PHP_EOL;
 
             // [3.5.11+] Insert a mark that indicates the framework form has started.
             // This will be checked in the validation method with the `is_admin_page_framework` input value which gets inserted at the end of the form
             // in order to determine all the fields are sent for the PHP max_input_vars limitation set in the server configuration.
-            echo "<input type='hidden' name='admin_page_framework_start' value='1' />" . PHP_EOL;
+            echo "<input type='hidden' name='admin_page_framework_start' value='1' />".PHP_EOL;
 
             // Embed the '_wp_http_referer' hidden field that is checked in the submit data processing method.
             settings_fields( $this->oFactory->oProp->sOptionKey );
@@ -280,19 +280,19 @@ 
          * @internal
          * @return      void
          */
-        private function _printFormClosingTag( $sPageSlug, $sTabSlug, $fEnableForm=true ) {
+        private function _printFormClosingTag( $sPageSlug, $sTabSlug, $fEnableForm = true ) {
 
-            if ( ! $fEnableForm ) {
+            if ( !$fEnableForm ) {
                 return;
             }
 
-            $_sNonceTransientKey    = 'form_' . md5( $this->oFactory->oProp->sClassName . get_current_user_id() );
-            $_sNonce                = $this->getTransient( $_sNonceTransientKey, '_admin_page_framework_form_nonce_' . uniqid() );
-            $this->setTransient( $_sNonceTransientKey, $_sNonce, 60*60 ); // 60 minutes
-            echo "<input type='hidden' name='page_slug' value='{$sPageSlug}' />" . PHP_EOL
-                . "<input type='hidden' name='tab_slug' value='{$sTabSlug}' />" . PHP_EOL
-                . "<input type='hidden' name='_is_admin_page_framework' value='{$_sNonce}' />" . PHP_EOL
-                . "</form><!-- End Form -->" . PHP_EOL;
+            $_sNonceTransientKey    = 'form_'.md5( $this->oFactory->oProp->sClassName.get_current_user_id() );
+            $_sNonce                = $this->getTransient( $_sNonceTransientKey, '_admin_page_framework_form_nonce_'.uniqid() );
+            $this->setTransient( $_sNonceTransientKey, $_sNonce, 60 * 60 ); // 60 minutes
+            echo "<input type='hidden' name='page_slug' value='{$sPageSlug}' />".PHP_EOL
+                . "<input type='hidden' name='tab_slug' value='{$sTabSlug}' />".PHP_EOL
+                . "<input type='hidden' name='_is_admin_page_framework' value='{$_sNonce}' />".PHP_EOL
+                . "</form><!-- End Form -->".PHP_EOL;
 
         }
 

development/factory/admin_page/_view/AdminPageFramework_View__PageRenderer__PageHeadingTabs.php

Doc Comments +2 added lines

@@ -60,6 +60,7 @@ 
          * @since       3.3.1       Moved from `AdminPageFramework_Page`.
          * @since       3.5.3       Deprecated the `$aOutput` parameter.
          * @since       3.6.3       Moved from `AdminPageFramework_Page_View`. Changed the name from `_getPageHeadingTabs()`.
+         * @param string $sTag
          * @return      string      the output of page heading tabs.
          */
         private function _getOutput( $aPage, $sTag ) {
@@ -100,6 +101,7 @@ 
              * @internal
              * @since       3.5.3
              * @since       3.6.3       Moved from `AdminPageFramework_Page_View`.
+             * @param string $sTag
              * @return      string      the HTML page heading tab navigation bar output.
              */
             private function _getPageHeadingtabNavigationBar( array $aPages, $sTag, $sCurrentPageSlug ) {

Spacing +12 added lines, -12 removed lines

@@ -45,7 +45,7 @@ 
         $_aPage = $this->oFactory->oProp->aPages[ $this->sPageSlug ];
 
         // If the page title is disabled, return an empty string.
-        if ( ! $_aPage[ 'show_page_title' ] ) {
+        if ( !$_aPage[ 'show_page_title' ] ) {
             return "";
         }
 
@@ -64,10 +64,10 @@ 
          */
         private function _getOutput( $aPage, $sTag ) {
 
-            $sTag  = $this->_getPageHeadingTabTag( $sTag, $aPage );
+            $sTag = $this->_getPageHeadingTabTag( $sTag, $aPage );
 
             // If the page heading tab visibility is disabled, or only one page is registered, return the title.
-            if ( ! $aPage[ 'show_page_heading_tabs' ] || count( $this->oFactory->oProp->aPages ) == 1 ) {
+            if ( !$aPage[ 'show_page_heading_tabs' ] || count( $this->oFactory->oProp->aPages ) == 1 ) {
                 return "<{$sTag}>"
                         . $aPage[ 'title' ]
                     . "</{$sTag}>";
@@ -105,9 +105,9 @@ 
             private function _getPageHeadingtabNavigationBar( array $aPages, $sTag, $sCurrentPageSlug ) {
 
                 $_oTabBar = new AdminPageFramework_TabNavigationBar(
-                    $aPages,     // tab items
+                    $aPages, // tab items
                     $sCurrentPageSlug, // active tab slug
-                    $sTag,       // container tag
+                    $sTag, // container tag
                     array(       // container attributes
                         // 'class' => '...',
                     ),
@@ -130,8 +130,8 @@ 
                  * @since           3.5.10
                  * @since       3.6.3       Moved from `AdminPageFramework_Page_View`.
                  */
-                public function _replyToFormatNavigationTabItem_PageHeadingTab( $aSubPage, $aStructure, $aPages, $aArguments=array() ) {
-                    switch( $aSubPage['type'] ) {
+                public function _replyToFormatNavigationTabItem_PageHeadingTab( $aSubPage, $aStructure, $aPages, $aArguments = array() ) {
+                    switch ( $aSubPage[ 'type' ] ) {
                         case 'link':
                             return $this->_getFormattedPageHeadingtabNavigationBarLinkItem( $aSubPage, $aStructure );
                         default:
@@ -148,10 +148,10 @@ 
                      */
                     private function _getFormattedPageHeadingtabNavigationBarPageItem( array $aSubPage, $aStructure ) {
 
-                        if ( ! isset( $aSubPage[ 'page_slug' ] ) ) {
+                        if ( !isset( $aSubPage[ 'page_slug' ] ) ) {
                             return array();
                         }
-                        if ( ! $aSubPage[ 'show_page_heading_tab' ] ) {
+                        if ( !$aSubPage[ 'show_page_heading_tab' ] ) {
                             return array();
                         }
                         return array(
@@ -182,10 +182,10 @@ 
                      */
                     private function _getFormattedPageHeadingtabNavigationBarLinkItem( array $aSubPage, $aStructure ) {
 
-                        if ( ! isset( $aSubPage[ 'href' ] ) ) {
+                        if ( !isset( $aSubPage[ 'href' ] ) ) {
                             return array();
                         }
-                        if ( ! $aSubPage[ 'show_page_heading_tab' ] ) {
+                        if ( !$aSubPage[ 'show_page_heading_tab' ] ) {
                             return array();
                         }
                         $aSubPage = array(
@@ -197,7 +197,7 @@ 
                             + array( 'class' => null )
                             + $aStructure;
 
-                        $aSubPage[ 'class' ] = trim( $aSubPage[ 'class' ] . ' link' );
+                        $aSubPage[ 'class' ] = trim( $aSubPage[ 'class' ].' link' );
                         return $aSubPage;
                     }
 

development/factory/admin_page/_view/AdminPageFramework_View__PageRenderer__ScreenIcon.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
     }
         /**
          * @since       3.6.3
-         * @return      boolean
+         * @return      boolean|null
          */
         private function _isScreenIconVisible() {
             

Spacing +12 added lines, -12 removed lines

@@ -40,7 +40,7 @@ 
      */
     public function get() {
 
-        if ( ! $this->_isScreenIconVisible() ) {
+        if ( !$this->_isScreenIconVisible() ) {
             return '';
         }
         return $this->_getScreenIcon( $this->sPageSlug );
@@ -52,7 +52,7 @@ 
          */
         private function _isScreenIconVisible() {
 
-            $_bShowPageTitle        = $this->getElement(
+            $_bShowPageTitle = $this->getElement(
                 $this->oFactory->oProp->aPages,
                 array( $this->sPageSlug, 'show_page_title' )
             );
@@ -130,7 +130,7 @@ 
                 array( $sPageSlug, 'href_icon_32x32' ),
                 ''
             );
-            if ( ! $_sScreenIconPath ) {
+            if ( !$_sScreenIconPath ) {
                 return;
             }
             $_sScreenIconPath = $this->getResolvedSRC(
@@ -140,7 +140,7 @@ 
             $_aAttributes = array(
                 'style'    => $this->getInlineCSS(
                     array(
-                        'background-image' => "url('" . esc_url( $_sScreenIconPath ) . "')"
+                        'background-image' => "url('".esc_url( $_sScreenIconPath )."')"
                     )
                 )
             );
@@ -164,12 +164,12 @@ 
                 array( $sPageSlug, 'screen_icon_id' ),
                 ''
             );
-            if ( ! $_sScreenIconID ) {
+            if ( !$_sScreenIconID ) {
                 return;
             }
 
             $_aAttributes = array(
-                'id'       => "icon-" . $_sScreenIconID,
+                'id'       => "icon-".$_sScreenIconID,
             );
 
             // Go to the catch clause.
@@ -192,16 +192,16 @@ 
                 'class'    => $this->getClassAttribute(
                     $this->getAOrB(
                         empty( $_sIconIDAttribute ) && $_oScreen->post_type,
-                        sanitize_html_class( 'icon32-posts-' . $_oScreen->post_type ),
+                        sanitize_html_class( 'icon32-posts-'.$_oScreen->post_type ),
                         ''
                     ),
                     $this->getAOrB(
                         empty( $_sIconIDAttribute ) || $_sIconIDAttribute == $this->oFactory->oProp->sClassName,
-                        'generic',  // the default value
+                        'generic', // the default value
                         ''
                     )
                 ),
-                'id'       => "icon-" . $_sIconIDAttribute,
+                'id'       => "icon-".$_sIconIDAttribute,
             );
             return $this->_getScreenIconByAttributes( $_aAttributes );
 
@@ -215,7 +215,7 @@ 
              */
             private function _getScreenIDAttribute( $oScreen ) {
 
-                if ( ! empty( $oScreen->parent_base ) ) {
+                if ( !empty( $oScreen->parent_base ) ) {
                     return $oScreen->parent_base;
                 }
                 if ( 'page' === $oScreen->post_type ) {
@@ -236,10 +236,10 @@ 
             private function _getScreenIconByAttributes( array $aAttributes ) {
 
                 $aAttributes[ 'class' ] = $this->getClassAttribute(
-                    'icon32',   // required for a screen icon container element.
+                    'icon32', // required for a screen icon container element.
                     $this->getElement( $aAttributes, 'class' )
                 );
-                return "<div " . $this->getAttributes( $aAttributes ) . ">"
+                return "<div ".$this->getAttributes( $aAttributes ).">"
                         . "<br />"
                     . "</div>";
 

development/factory/widget/AdminPageFramework_Widget_Factory.php

Doc Comments +1 added lines

@@ -23,6 +23,7 @@
      * Sets up internal properties.
      * 
      * @since       3.2.0
+     * @param AdminPageFramework_Widget_Model $oCaller
      * @return      void
      */
 	public function __construct( $oCaller, $sWidgetTitle, array $aArguments=array() ) {

Indentation +11 added lines, -11 removed lines

@@ -26,7 +26,7 @@ 
      * @since       3.2.0
      * @return      void
      */
-	public function __construct( $oCaller, $sWidgetTitle, array $aArguments=array() ) {
+    public function __construct( $oCaller, $sWidgetTitle, array $aArguments=array() ) {
 		
         $aArguments = $aArguments 
             + array( 
@@ -34,14 +34,14 @@ 
                 'description'   => '',  
             );
             
-		parent::__construct( 
+        parent::__construct( 
             $oCaller->oProp->sClassName,  // base id 
             $sWidgetTitle,      // widget title
             $aArguments         // widget arguments
         );
         $this->oCaller = $oCaller;
      
-	}
+    }
     
     /**
      * Displays the widget contents in the front end.
@@ -51,7 +51,7 @@ 
      * whether the title should be visible or not depending on the content.
      * @return      void
      */
-	public function widget( $aArguments, $aFormData ) {
+    public function widget( $aArguments, $aFormData ) {
            
         echo $aArguments[ 'before_widget' ];
         
@@ -74,9 +74,9 @@ 
 
         echo $_sContent;
         
-		echo $aArguments[ 'after_widget' ];
+        echo $aArguments[ 'after_widget' ];
 		
-	}
+    }
         /**
          * Returns the widget title.
          * 
@@ -105,7 +105,7 @@ 
             if ( ! $_sTitle ) {
                 return '';
             }
-           return $aArguments['before_title'] 
+            return $aArguments['before_title'] 
                 . $_sTitle 
             . $aArguments['after_title'];           
             
@@ -117,7 +117,7 @@ 
      * @since       3.2.0
      * @return      mixed       The validated form data. The type should be an array but it is dealt by the framework user it will be unknown.
      */
-	public function update( $aSubmittedFormData, $aSavedFormData ) {
+    public function update( $aSubmittedFormData, $aSavedFormData ) {
                 
         $aSubmittedFormData = $this->oCaller->oUtil->addAndApplyFilters(
             $this->oCaller, 
@@ -131,7 +131,7 @@ 
         );
         return $this->oCaller->oForm->getInputsUnset( $aSubmittedFormData, $this->oCaller->oForm->sStructureType ); // 3.8.17+
 
-	}
+    }
     
     /**
      * Constructs the widget form with the given saved form data.
@@ -142,7 +142,7 @@ 
      * 
      * @return      void
      */
-	public function form( $aSavedFormData ) {
+    public function form( $aSavedFormData ) {
         
         $this->oCaller->oForm->aCallbacks = $this->_getFormCallbacks() + $this->oCaller->oForm->aCallbacks;
 
@@ -181,7 +181,7 @@ 
         $this->oCaller->oForm->aSectionsets          = $_aSectionsets;
         $this->oCaller->oForm->aFieldsets            = $_aFieldsets;
         
-	}
+    }
         /**
          * Calls the load() method of the caller factory object.
          * 

Spacing +29 added lines, -29 removed lines

@@ -26,7 +26,7 @@ 
      * @since       3.2.0
      * @return      void
      */
-	public function __construct( $oCaller, $sWidgetTitle, array $aArguments=array() ) {
+	public function __construct( $oCaller, $sWidgetTitle, array $aArguments = array() ) {
 		
         $aArguments = $aArguments 
             + array( 
@@ -35,8 +35,8 @@ 
             );
             
 		parent::__construct( 
-            $oCaller->oProp->sClassName,  // base id 
-            $sWidgetTitle,      // widget title
+            $oCaller->oProp->sClassName, // base id 
+            $sWidgetTitle, // widget title
             $aArguments         // widget arguments
         );
         $this->oCaller = $oCaller;
@@ -57,7 +57,7 @@ 
         
         $this->oCaller->oUtil->addAndDoActions( 
             $this->oCaller, 
-            'do_' . $this->oCaller->oProp->sClassName, 
+            'do_'.$this->oCaller->oProp->sClassName, 
             $this->oCaller
         );
        
@@ -88,7 +88,7 @@ 
          */
         private function _getTitle( array $aArguments, array $aFormData ) {
                 
-            if ( ! $this->oCaller->oProp->bShowWidgetTitle ) {
+            if ( !$this->oCaller->oProp->bShowWidgetTitle ) {
                 return '';
             }
             
@@ -102,12 +102,12 @@ 
                 $aFormData,
                 $this->id_base 
             );
-            if ( ! $_sTitle ) {
+            if ( !$_sTitle ) {
                 return '';
             }
-           return $aArguments['before_title'] 
+           return $aArguments[ 'before_title' ] 
                 . $_sTitle 
-            . $aArguments['after_title'];           
+            . $aArguments[ 'after_title' ];           
             
         }
             
@@ -123,7 +123,7 @@ 
             $this->oCaller, 
             "validation_{$this->oCaller->oProp->sClassName}", 
             call_user_func_array( 
-                array( $this->oCaller, 'validate' ),    // triggers __call()
+                array( $this->oCaller, 'validate' ), // triggers __call()
                 array( $aSubmittedFormData, $aSavedFormData, $this->oCaller ) // parameters
             ), // 3.5.3+                        
             $aSavedFormData,
@@ -172,8 +172,8 @@ 
         $this->oCaller->oForm   = new AdminPageFramework_Form_widget(
             array(
                 'register_if_action_already_done' => false, // do not register fields right away
-            ) + $this->oCaller->oProp->aFormArguments,  // form arguments  
-            $this->oCaller->oForm->aCallbacks,  // callbacks 
+            ) + $this->oCaller->oProp->aFormArguments, // form arguments  
+            $this->oCaller->oForm->aCallbacks, // callbacks 
             $this->oCaller->oMsg
         );
         // Reuse the data of the previous widget instance.
@@ -199,7 +199,7 @@ 
              * Call the load method only once per class. Also the added field registrations in the class also done once.
              * @since       3.7.9
              */ 
-            if ( $this->oCaller->oUtil->hasBeenCalled( '_widget_load_' . $this->oCaller->oProp->sClassName ) ) {
+            if ( $this->oCaller->oUtil->hasBeenCalled( '_widget_load_'.$this->oCaller->oProp->sClassName ) ) {
 
                 /**
                  * The saved option callback is done with the below load_... callback so for widget form instances called from the second time
@@ -217,7 +217,7 @@ 
             $this->oCaller->oUtil->addAndDoActions( 
                 $this->oCaller, 
                 array(
-                    'load_' . $this->oCaller->oProp->sClassName, 
+                    'load_'.$this->oCaller->oProp->sClassName, 
                 ),
                 $this->oCaller 
             );            
@@ -231,9 +231,9 @@ 
          */
         private function _getFormCallbacks() {
             return array( 
-                'hfID'          => array( $this, 'get_field_id' ),    // defined in the WP_Widget class.  
-                'hfTagID'       => array( $this, 'get_field_id' ),    // defined in the WP_Widget class.  
-                'hfName'        => array( $this, '_replyToGetFieldName' ),  // defined in the WP_Widget class.  
+                'hfID'          => array( $this, 'get_field_id' ), // defined in the WP_Widget class.  
+                'hfTagID'       => array( $this, 'get_field_id' ), // defined in the WP_Widget class.  
+                'hfName'        => array( $this, '_replyToGetFieldName' ), // defined in the WP_Widget class.  
                 'hfInputName'   => array( $this, '_replyToGetFieldInputName' ),
                 
                 'saved_data'    => array( $this, '_replyToGetSavedFormData' ),
@@ -249,8 +249,8 @@ 
     public function  _replyToGetSavedFormData() {
         return $this->oCaller->oUtil->addAndApplyFilter(
             $this->oCaller, // the caller factory object
-            'options_' . $this->oCaller->oProp->sClassName,
-            $this->oCaller->oProp->aOptions,      // subject value to be filtered
+            'options_'.$this->oCaller->oProp->sClassName,
+            $this->oCaller->oProp->aOptions, // subject value to be filtered
             $this->id   // 3.7.9+
         );        
     }    
@@ -280,25 +280,25 @@ 
          */
         private function _getNameAttributeDimensions( $aFieldset ) {
 
-            $_sNamePrefix   = 'widget-' . $this->id_base . '[' . $this->number . ']';
+            $_sNamePrefix = 'widget-'.$this->id_base.'['.$this->number.']';
 
             $_sDimensions = '';
             if ( $this->oCaller->isSectionSet( $aFieldset ) ) {
-                $_aSectionPath       = $aFieldset[ '_section_path_array' ];
-                foreach( $_aSectionPath as $_sDimension ) {
-                    $_sDimensions .= '[' . $_sDimension . ']';
+                $_aSectionPath = $aFieldset[ '_section_path_array' ];
+                foreach ( $_aSectionPath as $_sDimension ) {
+                    $_sDimensions .= '['.$_sDimension.']';
                 }
                 if ( isset( $aFieldset[ '_section_index' ] ) ) {
-                    $_sDimensions .= '[' . $aFieldset[ '_section_index' ] . ']';
+                    $_sDimensions .= '['.$aFieldset[ '_section_index' ].']';
                 }
             }
 
             // 3.8.18+ Support for nested fields. @see  https://github.com/michaeluno/admin-page-framework/issues/274
-            foreach( $aFieldset[ '_field_path_array' ] as $_sPathPart ) {
-                $_sDimensions .= '[' . $_sPathPart . ']';
+            foreach ( $aFieldset[ '_field_path_array' ] as $_sPathPart ) {
+                $_sDimensions .= '['.$_sPathPart.']';
             }
 
-            return $_sNamePrefix . $_sDimensions;
+            return $_sNamePrefix.$_sDimensions;
         }        
     
     /**
@@ -315,10 +315,10 @@ 
         $_sIndex        = $this->oCaller->oUtil->getAOrB(
             '0' !== $sIndex && empty( $sIndex ),
             '',
-            "[" . $sIndex . "]"
+            "[".$sIndex."]"
         );
-        $_sNamePrefix   = $this->_replyToGetFieldName( '', $aFieldset );
-        return $_sNamePrefix . $_sIndex;
+        $_sNamePrefix = $this->_replyToGetFieldName( '', $aFieldset );
+        return $_sNamePrefix.$_sIndex;
 
     }
   

development/factory/admin_page/AdminPageFramework.php

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;

Spacing +6 added lines, -6 removed lines

@@ -68,9 +68,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;
         }
                         
@@ -90,19 +90,19 @@ 
          */
         private function _getCallerPath( $sCallerPath ) {
             
-            if ( $sCallerPath  ) {
+            if ( $sCallerPath ) {
                 return trim( $sCallerPath );
             }
             
-            if ( ! is_admin() ) {
+            if ( !is_admin() ) {
                 return null;
             }
             
-            if ( ! isset( $GLOBALS[ 'pagenow' ] ) ) {
+            if ( !isset( $GLOBALS[ 'pagenow' ] ) ) {
                 return null;
             }
             
-            $_sCalllerPath = in_array( $GLOBALS[ 'pagenow' ], array( 'plugins.php', ) ) || isset( $_GET[ 'page' ] )
+            $_sCalllerPath = in_array( $GLOBALS[ 'pagenow' ], array( 'plugins.php',) ) || isset( $_GET[ 'page' ] )
                 ? AdminPageFramework_Utility::getCallerScriptPath( __FILE__ ) // not using $oUtil as this method is caller earlier than the base constructor.
                 : null;
                 

Doc Comments +2 added lines, -1 removed lines

@@ -45,7 +45,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
@@ -84,6 +84,7 @@ 
         /**
          * Returns the script caller path.
          * @remark      It is important to find the caller script path here when separating the library into multiple files.
+         * @param string|null $sCallerPath
          * @return      null|string
          * @since       3.8.2
          */