michaeluno / admin-page-framework

development/factory/admin_page/_model/delegate/validaor/AdminPageFramework_Model__FormSubmission__Validator__Export.php

Doc Comments +2 added lines

@@ -92,6 +92,7 @@ 
              * 
              * @since       3.5.4
              * @since       3.6.3       Moved from `AdminPageFramework_Form_Model_Export`.
+             * @param string $sFileName
              * @return      array
              */
             private function _getExportHeaderArray( array $aArguments, $sFileName, $mData ) {
@@ -132,6 +133,7 @@ 
              * @since       3.5.3
              * @since       3.6.3       Moved from `AdminPageFramework_Form_Model_Export`.
              * @internal   
+             * @param string $mData
              * @return      string      The export file name.
              */        
             private function _getExportFileName( array $aArguments, $sExportFileName, $mData ) {        

Spacing +4 added lines, -4 removed lines

@@ -33,7 +33,7 @@ 
      */
     public function _replyToCallback( $aInputs, $aRawInputs, array $aSubmits, $aSubmitInformation, $oFactory ) {
         
-        if ( ! $this->_shouldProceed() ) {
+        if ( !$this->_shouldProceed() ) {
             return;
         }        
         $this->_exportOptions(
@@ -65,11 +65,11 @@ 
          */
         protected function _exportOptions( $mData, $sPageSlug, $sTabSlug ) {
 
-            $_oExport           = new AdminPageFramework_ExportOptions( 
+            $_oExport = new AdminPageFramework_ExportOptions( 
                 $_POST[ '__export' ], 
                 $this->oFactory->oProp->sClassName 
             );
-            $_aArguments        = array(
+            $_aArguments = array(
                 'class_name'        => $this->oFactory->oProp->sClassName,
                 'page_slug'         => $sPageSlug,
                 'tab_slug'          => $sTabSlug,
@@ -141,7 +141,7 @@ 
                     $sExportFileName, 
                     $aArguments[ 'pressed_field_id' ],
                     $aArguments[ 'pressed_input_id' ],
-                    $mData,     // 3.4.6+
+                    $mData, // 3.4.6+
                     $this->oFactory       // 3.4.6+
                 );    
             }

Braces +3 added lines, -3 removed lines

@@ -120,7 +120,7 @@ 
              * @internal   
              * @return      string      the filtered export data.
              */
-            private function _getFilteredExportingData( array $aArguments, $mData ) {                   
+            private function _getFilteredExportingData( array $aArguments, $mData ) {
                 return $this->_getFilteredItemForPortByPrefix(
                     'export_',
                     $mData,    
@@ -134,7 +134,7 @@ 
              * @internal   
              * @return      string      The export file name.
              */        
-            private function _getExportFileName( array $aArguments, $sExportFileName, $mData ) {        
+            private function _getExportFileName( array $aArguments, $sExportFileName, $mData ) {
                 return $this->addAndApplyFilters(
                     $this->oFactory,
                     $this->_getPortFilterHookNames( 'export_name_', $aArguments ),
@@ -152,7 +152,7 @@ 
              * @internal   
              * @return      string      The export format type.
              */        
-            private function _getExportFormatType( array $aArguments, $sExportFileFormat ) {  
+            private function _getExportFormatType( array $aArguments, $sExportFileFormat ) {
                 return $this->_getFilteredItemForPortByPrefix(
                     'export_format_',
                     $sExportFileFormat,    

development/factory/admin_page/_model/delegate/validaor/AdminPageFramework_Model__FormSubmission__Validator__Import.php

Doc Comments +4 added lines

@@ -143,6 +143,7 @@ 
                 /**
                  * Sets update admin notice.
                  * @since       3.5.3
+                 * @param boolean $bEmpty
                  * @return      void
                  */
                 private function _setImportAdminNotice( $bEmpty ) {
@@ -204,6 +205,8 @@ 
                  * @since       3.5.3
                  * @since       3.6.3       Moved from `AdminPageFramework_Form_Model_Import`.
                  * @internal   
+                 * @param string $sFormatType
+                 * @param string $sImportOptionKey
                  * @return      string      The filtered import data.
                  */    
                 private function _getFilteredImportData( array $aArguments, $mData, $aStoredOptions, $sFormatType, $sImportOptionKey ) {
@@ -232,6 +235,7 @@ 
      * @param       string      The filter prefix.
      * @param       mixed       The subject filtering value.
      * @param       array       An argument array holding submit information. Part of this will be passed to the filter callbacks but this itself does not mean is for the filter callbacks.
+     * @param string $sPrefix
      */
     protected function _getFilteredItemForPortByPrefix( $sPrefix, $mFilteringValue, array $aArguments ) {
         return $this->addAndApplyFilters(

Braces +2 added lines, -2 removed lines

@@ -102,7 +102,7 @@ 
                 // Check the uploaded file MIME type.
                 $_aMIMEType = $this->_getImportMIMEType( $_aArguments );
                 $_sType     = $_oImport->getType();
-                if ( ! in_array( $_sType, $_aMIMEType ) ) {        
+                if ( ! in_array( $_sType, $_aMIMEType ) ) {
                     $this->oFactory->setSettingNotice( sprintf( $this->oFactory->oMsg->get( 'uploaded_file_type_not_supported' ), $_sType ) );
                     return $aStoredOptions;        // do not change the framework's options.
                 }
@@ -163,7 +163,7 @@ 
                  * @since       3.5.3
                  * @return      array       An array holding processable MIME types.       
                  */
-                private function _getImportMIMEType( array $aArguments ) {  
+                private function _getImportMIMEType( array $aArguments ) {
                     return $this->_getFilteredItemForPortByPrefix(
                         'import_mime_types_',
                         array( 'text/plain', 'application/octet-stream' ), // .json file is dealt as a binary file.

Spacing +11 added lines, -11 removed lines

@@ -32,7 +32,7 @@ 
      * @callback    action      try_validation_after_{class name}
      */
     public function _replyToCallback( $aInputs, $aRawInputs, array $aSubmits, $aSubmitInformation, $oFactory ) {
-        if ( ! $this->_shouldProceed() ) {
+        if ( !$this->_shouldProceed() ) {
             return;
         }
         $this->_doImportOptions(
@@ -102,9 +102,9 @@ 
                 // Check the uploaded file MIME type.
                 $_aMIMEType = $this->_getImportMIMEType( $_aArguments );
                 $_sType     = $_oImport->getType();
-                if ( ! in_array( $_sType, $_aMIMEType ) ) {        
+                if ( !in_array( $_sType, $_aMIMEType ) ) {        
                     $this->oFactory->setSettingNotice( sprintf( $this->oFactory->oMsg->get( 'uploaded_file_type_not_supported' ), $_sType ) );
-                    return $aStoredOptions;        // do not change the framework's options.
+                    return $aStoredOptions; // do not change the framework's options.
                 }
 
                 // Retrieve the importing data.
@@ -169,7 +169,7 @@ 
                         array( 
                             'text/plain', 
                             'application/octet-stream', // .json file is dealt as a binary file.
-                            'application/json',  // DEVVER+ some servers cannot upload json files without this
+                            'application/json', // DEVVER+ some servers cannot upload json files without this
                         ), 
                         $aArguments
                     ); 
@@ -258,18 +258,18 @@ 
     protected function _getPortFilterHookNames( $sPrefix, array $aArguments ) {
         
         return array(
-            $sPrefix . $aArguments[ 'class_name' ] . '_' . $aArguments[ 'pressed_input_id' ],
+            $sPrefix.$aArguments[ 'class_name' ].'_'.$aArguments[ 'pressed_input_id' ],
             $aArguments[ 'section_id' ] 
-                ? $sPrefix . $aArguments[ 'class_name' ] . '_' . $aArguments[ 'section_id' ] .'_' . $aArguments[ 'pressed_field_id' ]
-                : $sPrefix . $aArguments[ 'class_name' ] . '_' . $aArguments[ 'pressed_field_id' ],
+                ? $sPrefix.$aArguments[ 'class_name' ].'_'.$aArguments[ 'section_id' ].'_'.$aArguments[ 'pressed_field_id' ]
+                : $sPrefix.$aArguments[ 'class_name' ].'_'.$aArguments[ 'pressed_field_id' ],
             $aArguments[ 'section_id' ] 
-                ? $sPrefix . $aArguments[ 'class_name' ] . '_' . $aArguments[ 'section_id' ] 
+                ? $sPrefix.$aArguments[ 'class_name' ].'_'.$aArguments[ 'section_id' ] 
                 : null,
             $aArguments[ 'tab_slug' ] 
-                ? $sPrefix . $aArguments[ 'page_slug' ] . '_' . $aArguments[ 'tab_slug' ]
+                ? $sPrefix.$aArguments[ 'page_slug' ].'_'.$aArguments[ 'tab_slug' ]
                 : null,
-            $sPrefix . $aArguments[ 'page_slug' ],
-            $sPrefix . $aArguments[ 'class_name' ]
+            $sPrefix.$aArguments[ 'page_slug' ],
+            $sPrefix.$aArguments[ 'class_name' ]
         );            
         
     }        

development/factory/admin_page/_model/delegate/validaor/AdminPageFramework_Model__FormSubmission__Validator__Redirect.php

Doc Comments +1 added lines

@@ -66,6 +66,7 @@
          * Sets the given URL's transient.
          * @since       unknown
          * @since       3.6.3       Moved from `AdminPageFramework_Validation`.
+         * @param string $sURL
          */
         private function _setRedirectTransients( $sURL, $sPageSlug ) {
             if ( empty( $sURL ) ) { 

Spacing +3 added lines, -3 removed lines

@@ -35,7 +35,7 @@ 
             $aSubmits, 
             'redirect_url' 
         );
-        if ( ! $_sRedirectURL ) {
+        if ( !$_sRedirectURL ) {
             return;
         }
         
@@ -71,8 +71,8 @@ 
             if ( empty( $sURL ) ) { 
                 return; 
             }
-            $_sTransient = 'apf_rurl' . md5( trim( "redirect_{$this->oFactory->oProp->sClassName}_{$sPageSlug}" ) );
-            return $this->setTransient( $_sTransient, $sURL , 60*2 );
+            $_sTransient = 'apf_rurl'.md5( trim( "redirect_{$this->oFactory->oProp->sClassName}_{$sPageSlug}" ) );
+            return $this->setTransient( $_sTransient, $sURL, 60 * 2 );
         }
  
 }
\ No newline at end of file

Braces +1 added lines, -1 removed lines

@@ -68,7 +68,7 @@
          * @since       3.6.3       Moved from `AdminPageFramework_Validation`.
          */
         private function _setRedirectTransients( $sURL, $sPageSlug ) {
-            if ( empty( $sURL ) ) { 
+            if ( empty( $sURL ) ) {
                 return; 
             }
             $_sTransient = 'apf_rurl' . md5( trim( "redirect_{$this->oFactory->oProp->sClassName}_{$sPageSlug}" ) );

development/factory/admin_page/_model/delegate/validaor/AdminPageFramework_Model__FormSubmission__Validator__Reset.php

Doc Comments +1 added lines

@@ -60,6 +60,7 @@
          * @since       3.6.3       Moved from `AdminPageFramework_Validation`.
          * @remark      `$aInputs` has only the page elements that called the validation callback. 
          * In other words, it does not hold other pages' option keys.
+         * @param string $sKeyToReset
          * @return      array       The modified input array.
          */
         private function _resetOptions( $sKeyToReset, array $aInputs, array $aSubmitInformation ) {

Spacing +3 added lines, -3 removed lines

@@ -41,7 +41,7 @@ 
             'reset_key' 
         );
         $_sKeyToReset = trim( $_sKeyToReset );
-        if ( ! $_sKeyToReset ) {
+        if ( !$_sKeyToReset ) {
             return;
         }            
         $_oException = new Exception( 'aReturn' );
@@ -68,12 +68,12 @@ 
             $this->_doResetActions( $sKeyToReset, $aInputs, $aSubmitInformation );
             
             // As of 3.1.0, an empty value is accepted for the option key.
-            if ( ! $this->oFactory->oProp->sOptionKey ) {
+            if ( !$this->oFactory->oProp->sOptionKey ) {
                 return array();
             }
             
             // The key to delete is not specified, 1 is sent from the form input.
-            if ( in_array( $sKeyToReset, array( '1', ), true ) ) {
+            if ( in_array( $sKeyToReset, array( '1',), true ) ) {
                 delete_option( $this->oFactory->oProp->sOptionKey );
                 return array();
             }

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

Braces +1 added lines, -1 removed lines

@@ -244,7 +244,7 @@
          * @internal
          * @return      void
          */ 
-        private function _printFormOpeningTag( $fEnableForm=true ) {    
+        private function _printFormOpeningTag( $fEnableForm=true ) {
             
             if ( ! $fEnableForm ) {
                 return;

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

Braces +2 added lines, -2 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 ""; 
         }
 
@@ -130,7 +130,7 @@ 
                  * @since           3.5.10
                  * @since       3.6.3       Moved from `AdminPageFramework_Page_View`.
                  */            
-                public function _replyToFormatNavigationTabItem_PageHeadingTab( $aSubPage, $aStructure, $aPages, $aArguments=array() ) {                    
+                public function _replyToFormatNavigationTabItem_PageHeadingTab( $aSubPage, $aStructure, $aPages, $aArguments=array() ) {
                     switch( $aSubPage['type'] ) {
                         case 'link':
                             return $this->_getFormattedPageHeadingtabNavigationBarLinkItem( $aSubPage, $aStructure );

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,14 +130,14 @@ 
                 array( $sPageSlug, 'href_icon_32x32' ),
                 ''
             );
-            if ( ! $_sScreenIconPath ) {
+            if ( !$_sScreenIconPath ) {
                 return;
             }
             
             $_aAttributes = array(
                 'style'    => $this->generateInlineCSS(
                     array(
-                        'background-image' => "url('" . esc_url( $_sScreenIconPath ) . "')"
+                        'background-image' => "url('".esc_url( $_sScreenIconPath )."')"
                     )
                 )
             );
@@ -161,12 +161,12 @@ 
                 array( $sPageSlug, 'screen_icon_id' ),
                 ''
             );
-            if ( ! $_sScreenIconID ) {
+            if ( !$_sScreenIconID ) {
                 return;
             }
             
             $_aAttributes = array(
-                'id'       => "icon-" . $_sScreenIconID,
+                'id'       => "icon-".$_sScreenIconID,
             );
             
             // Go to the catch clause.
@@ -189,16 +189,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 );
         
@@ -212,7 +212,7 @@ 
              */     
             private function _getScreenIDAttribute( $oScreen ) {
                 
-                if ( ! empty( $oScreen->parent_base ) ) {
+                if ( !empty( $oScreen->parent_base ) ) {
                     return $oScreen->parent_base;
                 }
                 if ( 'page' === $oScreen->post_type ) {
@@ -233,10 +233,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>";
                 

Braces +1 added lines, -1 removed lines

@@ -181,7 +181,7 @@
          * @since       3.6.3       Moved from `AdminPageFramework_Page_View`.
          * @return      string      
          */
-        private function _getDefaultScreenIcon() {            
+        private function _getDefaultScreenIcon() {
 
             $_oScreen           = get_current_screen();
             $_sIconIDAttribute  = $this->_getScreenIDAttribute( $_oScreen );

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;

Indentation +6 added lines, -6 removed lines

@@ -1,11 +1,11 @@
 <?php
 /**
- * Admin Page Framework
- * 
- * http://en.michaeluno.jp/admin-page-framework/
- * Copyright (c) 2013-2015 Michael Uno; Licensed MIT
- * 
- */
+     * Admin Page Framework
+     * 
+     * http://en.michaeluno.jp/admin-page-framework/
+     * Copyright (c) 2013-2015 Michael Uno; Licensed MIT
+     * 
+     */
 
 /**
  * Provides methods for creating fields in the taxonomy page (edit-tags.php).

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