michaeluno / admin-page-framework

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_Controller_Form.php

Doc Comments -3 removed lines

@@ -153,9 +153,6 @@
     * @since        3.5.3       Removed the parameter declarations as they are caught with the func_get_args().
     * @access       public
     * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-    * @param        string      $sSectionID1        the section ID to remove.
-    * @param        string      $sSectionID2        (optional) another section ID to remove.
-    * @param        string      $_and_more          (optional) add more section IDs to the next parameters as many as necessary.
     * @return       void
     */    
     public function removeSettingSections( /* $sSectionID1=null, $sSectionID2=null, $_and_more=null */ ) {    

Indentation +45 added lines, -45 removed lines

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

Braces +5 added lines, -5 removed lines

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

Spacing +17 added lines, -17 removed lines

@@ -72,7 +72,7 @@ 
      */     
     public function addSettingSections( /* $aSection1, $aSection2=null, $_and_more=null */ ) {
         
-        foreach( func_get_args() as $asSection ) { 
+        foreach ( func_get_args() as $asSection ) { 
             $this->addSettingSection( $asSection ); 
         }
         
@@ -95,7 +95,7 @@ 
      */
     public function addSettingSection( $asSection ) {
                 
-        if ( ! is_array( $asSection ) ) {
+        if ( !is_array( $asSection ) ) {
             $this->_sTargetPageSlug = is_string( $asSection )
                 ? $asSection 
                 : $this->_sTargetPageSlug;
@@ -117,10 +117,10 @@ 
             )
         ); 
         
-        $aSection[ 'section_tab_slug' ]   = $this->oUtil->sanitizeSlug( $aSection[ 'section_tab_slug' ] );
+        $aSection[ 'section_tab_slug' ] = $this->oUtil->sanitizeSlug( $aSection[ 'section_tab_slug' ] );
         
         // A page slug is required.
-        if ( ! $aSection[ 'page_slug' ] ) {
+        if ( !$aSection[ 'page_slug' ] ) {
             return; 
         }
         $this->oForm->addSection( $aSection );
@@ -136,8 +136,8 @@ 
         private function _getTargetPageSlug( $aSection ) {
             
             $_sTargetPageSlug = $this->oUtil->getElement( 
-                $aSection,      // subject
-                'page_slug',    // key
+                $aSection, // subject
+                'page_slug', // key
                 $this->_sTargetPageSlug     // default
             );
          
@@ -157,8 +157,8 @@ 
          */
         private function _getTargetTabSlug( $aSection ) {
             $_sTargetTabSlug = $this->oUtil->getElement( 
-                $aSection,              // subject
-                'tab_slug',             // key
+                $aSection, // subject
+                'tab_slug', // key
                 $this->_sTargetTabSlug  // default
             );
             $_sTargetTabSlug = $_sTargetTabSlug
@@ -187,7 +187,7 @@ 
     * @return       void
     */    
     public function removeSettingSections( /* $sSectionID1=null, $sSectionID2=null, $_and_more=null */ ) {    
-        foreach( func_get_args() as $_sSectionID ) {
+        foreach ( func_get_args() as $_sSectionID ) {
             $this->oForm->removeSection( $_sSectionID );
         }        
     }
@@ -245,7 +245,7 @@ 
      * @remark      The actual registration will be performed in the <em>_replyToRegisterSettings()</em> method with the <em>admin_menu</em> hook.
      */     
     public function addSettingFields( /* $aField1, $aField2=null, $_and_more=null */ ) {    
-        foreach( func_get_args() as $aField ) { 
+        foreach ( func_get_args() as $aField ) { 
             $this->addSettingField( $aField ); 
         }
     }
@@ -282,8 +282,8 @@ 
     * @param        string      $_and_more      (optional) add more field IDs to the next parameters as many as necessary.
     * @return void
     */    
-    public function removeSettingFields( $sFieldID1, $sFieldID2=null, $_and_more ) {
-        foreach( func_get_args() as $_sFieldID ) { 
+    public function removeSettingFields( $sFieldID1, $sFieldID2 = null, $_and_more ) {
+        foreach ( func_get_args() as $_sFieldID ) { 
             $this->oForm->removeField( $_sFieldID ); 
         }
     }    
@@ -330,7 +330,7 @@ 
             $this->oProp->sOptionKey, 
             empty( $_aParams ) 
                 ? null                  // will return the entire options array
-                : $_aDimensionalKeys,   // dimensional keys
+                : $_aDimensionalKeys, // dimensional keys
             $_mDefault, // default
             $this->getSavedOptions() + $this->oForm->getDefaultFormValues()
         );
@@ -349,21 +349,21 @@ 
      * If the user has not submitted the form, the framework will try to return the default value set in the field definition array.
      * @deprecated  3.3.0
      */
-    public function getFieldValue( $sFieldID, $sSectionID='' ) {
+    public function getFieldValue( $sFieldID, $sSectionID = '' ) {
                                    
         $this->oUtil->showDeprecationNotice(
-            'The method,' . __METHOD__ . ',', // deprecated item
+            'The method,'.__METHOD__.',', // deprecated item
             'getValue()' // alternative
         );     
     
         $_aOptions = $this->oUtil->uniteArrays( $this->oProp->aOptions, $this->oForm->getDefaultFormValues() );
         /* If it's saved, return it */
-        if ( ! $sSectionID ) {
+        if ( !$sSectionID ) {
             if ( array_key_exists( $sFieldID, $_aOptions ) ) {
                 return $_aOptions[ $sFieldID ];
             }    
             // loop through section elements
-            foreach( $_aOptions as $aOptions ) {
+            foreach ( $_aOptions as $aOptions ) {
                 if ( array_key_exists( $sFieldID, $aOptions ) ) {
                     return $aOptions[ $sFieldID ];
                 }

development/factory/admin_page/form/AdminPageFramework_Form_admin_page.php

Doc Comments +1 added lines

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

Braces +3 added lines, -3 removed lines

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

Spacing +19 added lines, -19 removed lines

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

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

@@ -27,7 +27,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,14 +35,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.
@@ -52,7 +52,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' ];
         
@@ -75,9 +75,9 @@ 
 
         echo $_sContent;
         
-		echo $aArguments[ 'after_widget' ];
+        echo $aArguments[ 'after_widget' ];
 		
-	}
+    }
         /**
          * Returns the widget title.
          * 
@@ -106,7 +106,7 @@ 
             if ( ! $_sTitle ) {
                 return '';
             }
-           return $aArguments['before_title'] 
+            return $aArguments['before_title'] 
                 . $_sTitle 
             . $aArguments['after_title'];           
             
@@ -118,7 +118,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 ) {
                 
         return $this->oCaller->oUtil->addAndApplyFilters(
             $this->oCaller, 
@@ -131,7 +131,7 @@ 
             $this->oCaller
         );
  
-	}
+    }
     
     /**
      * 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();
 
@@ -181,7 +181,7 @@ 
         $this->oCaller->oForm->aSectionsets          = $_aSectionsets;
         $this->oCaller->oForm->aFieldsets            = $_aFieldsets;
         
-	}
+    }
         /**
          * Calls the load() method of the caller factory object.
          * 

Spacing +22 added lines, -22 removed lines

@@ -27,7 +27,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( 
@@ -36,8 +36,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;
@@ -58,7 +58,7 @@ 
         
         $this->oCaller->oUtil->addAndDoActions( 
             $this->oCaller, 
-            'do_' . $this->oCaller->oProp->sClassName, 
+            'do_'.$this->oCaller->oProp->sClassName, 
             $this->oCaller
         );
        
@@ -89,7 +89,7 @@ 
          */
         private function _getTitle( array $aArguments, array $aFormData ) {
                 
-            if ( ! $this->oCaller->oProp->bShowWidgetTitle ) {
+            if ( !$this->oCaller->oProp->bShowWidgetTitle ) {
                 return '';
             }
             
@@ -103,12 +103,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' ];           
             
         }
             
@@ -124,7 +124,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.
@@ -194,7 +194,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
                 // need to call the callback manually.
@@ -208,7 +208,7 @@ 
             $this->oCaller->oUtil->addAndDoActions( 
                 $this->oCaller, 
                 array(
-                    'load_' . $this->oCaller->oProp->sClassName, 
+                    'load_'.$this->oCaller->oProp->sClassName, 
                 ),
                 $this->oCaller 
             );            
@@ -222,9 +222,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' ),
@@ -241,8 +241,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+
         );        
     }    
@@ -275,9 +275,9 @@ 
                 ? "[{$aFieldset[ '_section_index' ]}]" 
                 : "";             
             $_sDimensions   = $this->oCaller->isSectionSet( $aFieldset )
-                ? $aFieldset[ 'section_id' ] . "]" . $_sSectionIndex . "[" . $aFieldset[ 'field_id' ]
+                ? $aFieldset[ 'section_id' ]."]".$_sSectionIndex."[".$aFieldset[ 'field_id' ]
                 : $aFieldset[ 'field_id' ];                
-            return 'widget-' . $this->id_base . '[' . $this->number . '][' . $_sDimensions . ']';
+            return 'widget-'.$this->id_base.'['.$this->number.']['.$_sDimensions.']';
         }        
     
     /**
@@ -294,9 +294,9 @@ 
         $_sIndex        = $this->oCaller->oUtil->getAOrB(
             '0' !== $sIndex && empty( $sIndex ),
             '',
-            "[" . $sIndex . "]"
+            "[".$sIndex."]"
         );                   
-        return $this->_replyToGetFieldName( '', $aFieldset ) . $_sIndex;
+        return $this->_replyToGetFieldName( '', $aFieldset ).$_sIndex;
 
     }
   

development/utility/readme_parser/AdminPageFramework_WPReadmeParser.php

Doc Comments +1 added lines, -1 removed lines

@@ -81,7 +81,6 @@ 
      *      'code_block'        =>  ...,
      *      
      * )`
-     * @param       array       $aOptions           The options array which determines the behaviour of the class.
      * @since       3.5.0
      * @since       3.6.0       Made it accept string content to be passed to the first parameter.
      */
@@ -156,6 +155,7 @@ 
          * Returns the parsed text.
          * @since       3.5.0
          * @internal
+         * @param string $sContent
          */
         private function _getParsedText( $sContent ) {
 

Spacing +6 added lines, -6 removed lines

@@ -85,7 +85,7 @@ 
      * @since       3.5.0
      * @since       3.6.0       Made it accept string content to be passed to the first parameter.
      */
-    public function __construct( $sFilePathOrContent='', array $aReplacements=array(), array $aCallbacks=array() ) {
+    public function __construct( $sFilePathOrContent = '', array $aReplacements = array(), array $aCallbacks = array() ) {
 
         $this->sText            = file_exists( $sFilePathOrContent )
             ? file_get_contents( $sFilePathOrContent )
@@ -121,7 +121,7 @@ 
                 '/^[\s]*==[\s]*(.+?)[\s]*==/m', 
                 $sText,
                 -1, 
-                PREG_SPLIT_DELIM_CAPTURE|PREG_SPLIT_NO_EMPTY 
+                PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY 
             );         
             return $_aSections;
         }
@@ -132,7 +132,7 @@ 
      * @since       3.5.0
      * @return      string
      */
-    public function get( $sSectionName='' ) {
+    public function get( $sSectionName = '' ) {
         return $sSectionName
             ? $this->getSection( $sSectionName )
             : $this->_getParsedText( $this->sText );
@@ -194,7 +194,7 @@ 
          */
         public function _replyToReplaceCodeBlocks( $aMatches ) {
             
-            if ( ! isset( $aMatches[ 1 ] ) ) {
+            if ( !isset( $aMatches[ 1 ] ) ) {
                 return $aMatches[ 0 ];
             }
             
@@ -217,7 +217,7 @@ 
      */
     public function getRawSection( $sSectionName ) {
 
-        $_iIndex   = array_search( $sSectionName, $this->_aSections );  
+        $_iIndex = array_search( $sSectionName, $this->_aSections );  
         return false === $_iIndex
             ? ''
             : trim( $this->_aSections[ $_iIndex + 1 ] );
@@ -237,7 +237,7 @@ 
         // If <?php notation is missing, highlight_string() will not highlight the syntax so add it.
         $_bHasPHPTag = "<?php" === substr( $sCode, 0, 5 );
         
-        $sCode = $_bHasPHPTag ? $sCode : "<?php " . $sCode;
+        $sCode = $_bHasPHPTag ? $sCode : "<?php ".$sCode;
         
         $sCode = str_replace( '"', "'", $sCode ); // highlight_string() crashes if double quotes are contained in the code.
         $sCode = highlight_string( $sCode, true );

include/class/admin/_abstract/AdminPageFrameworkLoader_AdminPage_Tab_ReadMeBase.php

Doc Comments +2 added lines

@@ -20,6 +20,8 @@
     /**
      * 
      * @since       3.5.3
+     * @param string $sFilePath
+     * @param string $sTOCTitle
      */
     protected function _getReadmeContents( $sFilePath, $sTOCTitle, $asSections=array() ) {
         

Indentation +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
             return $_oTOC->get();        
         }
         return ''
-         . $_sContent;
+            . $_sContent;
         
     }
     

Spacing +11 added lines, -11 removed lines

@@ -21,7 +21,7 @@ 
      * 
      * @since       3.5.3
      */
-    protected function _getReadmeContents( $sFilePath, $sTOCTitle, $asSections=array() ) {
+    protected function _getReadmeContents( $sFilePath, $sTOCTitle, $asSections = array() ) {
         
         $_oWPReadmeParser = new AdminPageFramework_WPReadmeParser( 
             $sFilePath, 
@@ -34,7 +34,7 @@ 
             )
         );    
         $_sContent = '';
-        foreach( ( array ) $asSections as $_sSection  ) {
+        foreach ( ( array ) $asSections as $_sSection ) {
             $_sContent .= $_oWPReadmeParser->getSection( $_sSection );  
         }        
         if ( $sTOCTitle ) {            
@@ -66,7 +66,7 @@ 
              * @since       3.6.1
              * @return      string      The generate HTML output.
              */
-            public function _replyToProcessShortcode_embed( $aAttributes, $sURL, $sShortcode='' ) {
+            public function _replyToProcessShortcode_embed( $aAttributes, $sURL, $sShortcode = '' ) {
 
                 $sURL   = isset( $aAttributes[ 'src' ] ) ? $aAttributes[ 'src' ] : $sURL;      
                 $_sHTML = wp_oembed_get( $sURL );
@@ -108,27 +108,27 @@ 
      *  array( 'Second Heading' => 'Another text', ),
      * )
      */
-    public function getContentsByHeader( $sContents, $iHeaderNumber=2 ) {
+    public function getContentsByHeader( $sContents, $iHeaderNumber = 2 ) {
     
         $_aContents = array();
         $_aSplitContents = preg_split( 
             // '/^[\s]*==[\s]*(.+?)[\s]*==/m', 
-            '/(<h[' . $iHeaderNumber . ']*[^>]*>.*?<\/h[' . $iHeaderNumber . ']>)/i',
+            '/(<h['.$iHeaderNumber.']*[^>]*>.*?<\/h['.$iHeaderNumber.']>)/i',
             $sContents,
             -1, 
-            PREG_SPLIT_DELIM_CAPTURE|PREG_SPLIT_NO_EMPTY 
+            PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY 
         );                   
 
-        foreach( $_aSplitContents as $_iIndex => $_sSplitContent ) {
-            if ( ! preg_match( '/<h[' . $iHeaderNumber . ']*[^>]*>(.*?)<\/h[' . $iHeaderNumber . ']>/i', $_sSplitContent , $_aMatches ) ) {
+        foreach ( $_aSplitContents as $_iIndex => $_sSplitContent ) {
+            if ( !preg_match( '/<h['.$iHeaderNumber.']*[^>]*>(.*?)<\/h['.$iHeaderNumber.']>/i', $_sSplitContent, $_aMatches ) ) {
                 continue;
             }
         
-            if ( ! isset( $_aMatches[ 1 ] ) ) {
+            if ( !isset( $_aMatches[ 1 ] ) ) {
                 continue;
             }
-            if ( isset( $_aSplitContents[ $_iIndex + 1 ] ) )  {
-                $_aContents[] = array( 
+            if ( isset( $_aSplitContents[ $_iIndex + 1 ] ) ) {
+                $_aContents[ ] = array( 
                     $_aMatches[ 1 ],
                     $_aSplitContents[ $_iIndex + 1 ]
                 );

Braces +2 added lines, -2 removed lines

@@ -37,7 +37,7 @@ 
         foreach( ( array ) $asSections as $_sSection  ) {
             $_sContent .= $_oWPReadmeParser->getSection( $_sSection );  
         }        
-        if ( $sTOCTitle ) {            
+        if ( $sTOCTitle ) {
             $_oTOC = new AdminPageFramework_TableOfContents(
                 $_sContent,
                 4,
@@ -127,7 +127,7 @@ 
             if ( ! isset( $_aMatches[ 1 ] ) ) {
                 continue;
             }
-            if ( isset( $_aSplitContents[ $_iIndex + 1 ] ) )  {
+            if ( isset( $_aSplitContents[ $_iIndex + 1 ] ) ) {
                 $_aContents[] = array( 
                     $_aMatches[ 1 ],
                     $_aSplitContents[ $_iIndex + 1 ]

include/class/admin/admin-page-framework/tool/generator/AdminPageFrameworkLoader_AdminPage_Tool_Generator_Generator.php

Doc Comments +4 added lines, -5 removed lines

@@ -257,6 +257,7 @@ 
          * Generates the framework zip data.
          * 
          * @since       3.5.4
+         * @param string $sFrameworkDirPath
          * @return      string      The binary zip data.
          */
         private function _getDownloadFrameworkZipFile( $sFrameworkDirPath, $sDestinationPath ) {
@@ -308,11 +309,7 @@ 
                  * 
                  * @since       3.5.4
                  * @remark      string      $sPath              The path to check. It can be a directory or a file.
-                 * @param       string      $sPathInArchive     The parsing directory path set to the archive. 
-                 * The passed path for the archive has a trailing slash. It starts with a directory name.
-                 * e.g.
-                 * `utility/AdminPageFramework_WPReadmeParser/`
-                 * `factory/widget/model/`
+                 * @param string $sPath
                  * @return      boolean
                  */
                 private function _isAllowedArchivePath( $sPath ) {
@@ -567,6 +564,7 @@ 
                  * Modifies the text domain in the given file contents.
                  * 
                  * @since       3.5.4
+                 * @param string $sFileContents
                  * @return      string
                  */                
                 private function _modifyTextDomain( $sFileContents ) {
@@ -585,6 +583,7 @@ 
                      * Retrieves the value from the $_POST array by the given field ID.
                      * 
                      * @since       3.5.4
+                     * @param string $sFieldID
                      * @return      string
                      */
                     private function _getFormSubmitValueByFieldIDAsString( $sFieldID ) {

Braces +1 added lines, -1 removed lines

@@ -168,7 +168,7 @@
      * )      
      * </code>
      */
-    public function replyToFilterFileName( $sFileName, $sFieldID, $sInputID, $vExportingData, $oAdminPage ) { 
+    public function replyToFilterFileName( $sFileName, $sFieldID, $sInputID, $vExportingData, $oAdminPage ) {
 
         return isset( 
                 $_POST[ $this->oFactory->oProp->sOptionKey ][ $this->sSectionID ][ 'minified_script_name' ] 

Spacing +32 added lines, -32 removed lines

@@ -30,7 +30,7 @@ 
         $this->oFactory = $oFactory;
         
         add_action( 
-            'export_name_' . $this->sPageSlug . '_' . $this->sTabSlug, 
+            'export_name_'.$this->sPageSlug.'_'.$this->sTabSlug, 
             array( $this, 'replyToFilterFileName' ), 
             10, 
             5 
@@ -127,8 +127,8 @@ 
                 'label_min_width'   => 0,
                 'order'             => 100,
                 'value'             => __( 'Download', 'adimn-page-framework-demo' ),
-                'file_name'         => 'admin-page-framework.zip',  // the default file name. This will be modified by the filter.
-                'format'            => 'text',  // 'json', 'text', 'array'      
+                'file_name'         => 'admin-page-framework.zip', // the default file name. This will be modified by the filter.
+                'format'            => 'text', // 'json', 'text', 'array'      
                 'description'       => $oFactory->oUtil->getAOrB(
                     class_exists( 'ZipArchive' ),
                     __( 'Download the compiled framework files as a zip file.', 'admin-page-framework-loader' ),
@@ -182,8 +182,8 @@ 
         
         // the class prefix must not contain white spaces and some other characters not supported in PHP class names.
         preg_match( 
-            '/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/',     // pattern - allowed characters for variables in PHP.
-            $aInput[ 'class_prefix' ],     // subject
+            '/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', // pattern - allowed characters for variables in PHP.
+            $aInput[ 'class_prefix' ], // subject
             $_aMatches 
         );
         if ( $aInput[ 'class_prefix' ] && empty( $_aMatches ) ) {
@@ -191,13 +191,13 @@ 
             $_bVerified = false;
         }
                         
-        if ( ! $aInput[ 'text_domain' ] ) {
+        if ( !$aInput[ 'text_domain' ] ) {
             $_aErrors[ $this->sSectionID ][ 'text_domain' ] = __( 'The text domain cannot be empty.', 'admin-page-framework-loader' );
             $_bVerified = false;
         }
                 
         // An invalid value is found. Set a field error array and an admin notice and return the old values.
-        if ( ! $_bVerified ) {
+        if ( !$_bVerified ) {
             $oAdminPage->setFieldErrors( $_aErrors );     
             $oAdminPage->setSettingNotice( __( 'There was something wrong with your input.', 'admin-page-framework-loader' ) );
             return $aOldInput;
@@ -239,8 +239,8 @@ 
      */
     public function replyToDownloadFramework( $aSavedData, $sSubmittedFieldID, $sSubmittedInputID, $oAdminPage ) {
         
-        $_sFrameworkDirPath = AdminPageFrameworkLoader_Registry::$sDirPath . '/library/apf';
-        if ( ! file_exists( $_sFrameworkDirPath ) ) {
+        $_sFrameworkDirPath = AdminPageFrameworkLoader_Registry::$sDirPath.'/library/apf';
+        if ( !file_exists( $_sFrameworkDirPath ) ) {
             return $aSavedData;
         }
         
@@ -249,7 +249,7 @@ 
             $_sFrameworkDirPath, 
             $_sTempFile
         );
-        header( "Content-Length: " . strlen( $_sData ) ); 
+        header( "Content-Length: ".strlen( $_sData ) ); 
         unlink( $_sTempFile );
         return $_sData;
         
@@ -266,9 +266,9 @@ 
                 $sFrameworkDirPath, 
                 $sDestinationPath, 
                 array(
-                    'include_directory'             => false,   // wrap contents in a sub-directory
+                    'include_directory'             => false, // wrap contents in a sub-directory
                     'additional_source_directories' => apply_filters(
-                        AdminPageFrameworkLoader_Registry::HOOK_SLUG . '_filter_generator_additional_source_directories',
+                        AdminPageFrameworkLoader_Registry::HOOK_SLUG.'_filter_generator_additional_source_directories',
                         array() // directory paths 
                     ),
                 ),                
@@ -279,7 +279,7 @@ 
                 ) 
             );
             $_bSucceed = $_oZip->compress();
-            if ( ! $_bSucceed ) {
+            if ( !$_bSucceed ) {
                 return '';
             }
             return file_get_contents( $sDestinationPath );
@@ -299,7 +299,7 @@ 
 
                 // Check if it belongs to selected components.
                 if ( false === $this->_isAllowedArchivePath( $sPathInArchive ) ) {
-                    return '';  // empty value will drop the entry
+                    return ''; // empty value will drop the entry
                 }                
                 return $sPathInArchive;
                            
@@ -318,7 +318,7 @@ 
                  */
                 private function _isAllowedArchivePath( $sPath ) {
                     
-                    foreach( $this->_getDisallowedArchiveDirectoryPaths() as $_sDisallowedPath ) {
+                    foreach ( $this->_getDisallowedArchiveDirectoryPaths() as $_sDisallowedPath ) {
                         $_bHasPrefix = $this->oFactory->oUtil->hasPrefix( 
                             ltrim( $_sDisallowedPath, '/' ), // needle
                             ltrim( $sPath, '/' ) // haystack
@@ -387,7 +387,7 @@ 
                     // List paths.
                     $_aAllComponentsPaths       = array();
                     $_aSelectedComponentsPaths  = array();
-                    foreach( $this->_aComponentPaths as $_sKey => $_aPaths ) {
+                    foreach ( $this->_aComponentPaths as $_sKey => $_aPaths ) {
                     
                         // Extract all component paths.
                         $_aAllComponentsPaths = array_merge(
@@ -442,16 +442,16 @@ 
 
                 // Check the file extension.
                 $_aAllowedExtensions = apply_filters(
-                    AdminPageFrameworkLoader_Registry::HOOK_SLUG . '_filter_generator_allowed_file_extensions',
+                    AdminPageFrameworkLoader_Registry::HOOK_SLUG.'_filter_generator_allowed_file_extensions',
                     array( 'php', 'css', 'js' )
                 );
-                if ( ! in_array( pathinfo( $sPathInArchive, PATHINFO_EXTENSION ), $_aAllowedExtensions ) ) {
+                if ( !in_array( pathinfo( $sPathInArchive, PATHINFO_EXTENSION ), $_aAllowedExtensions ) ) {
                     return $sFileContents;
                 }            
                 
                 // Modify the file contents.
                 $sFileContents = apply_filters(
-                    AdminPageFrameworkLoader_Registry::HOOK_SLUG . '_filter_generator_file_contents',
+                    AdminPageFrameworkLoader_Registry::HOOK_SLUG.'_filter_generator_file_contents',
                     $sFileContents, 
                     $sPathInArchive,
                     $this->oFactory->oUtil->getElement(
@@ -512,12 +512,12 @@ 
                             $this->_getCheckedComponents()
                         );
                         $_aInsert = array(
-                            'Included Components: ' . implode( ', ', $_aCheckedComponents ),
-                            'Generated on ' . date( 'Y-m-d' ),  // today's date
+                            'Included Components: '.implode( ', ', $_aCheckedComponents ),
+                            'Generated on '.date( 'Y-m-d' ), // today's date
                         );
                         return preg_replace(
                             '#\*/#', // needle - matches '*/'
-                            implode( PHP_EOL . ' ', $_aInsert ) . ' \0', // replacement \0 is a back-reference to '*/'
+                            implode( PHP_EOL.' ', $_aInsert ).' \0', // replacement \0 is a back-reference to '*/'
                             $sFileContents, // subject
                             1 // replace only the first occurrence
                         );      
@@ -531,14 +531,14 @@ 
                     private function _modifyClassNameOfInclusionList( $sFileContents ) {
                         // Replace the array key names.
                         $sFileContents = preg_replace_callback(
-                            '/(["\'])(.+)\1(?=\s?+=>)/',  // pattern '
-                            array( $this, '_replyToModifyPathName' ),   // callable
+                            '/(["\'])(.+)\1(?=\s?+=>)/', // pattern '
+                            array( $this, '_replyToModifyPathName' ), // callable
                             $sFileContents // subject
                         );     
                         // Replace the registry class names.
                         return preg_replace_callback(
-                            '/(=>\s?+)(.+)(?=::)/',  // pattern '
-                            array( $this, '_replyToModifyPathName' ),   // callable
+                            '/(=>\s?+)(.+)(?=::)/', // pattern '
+                            array( $this, '_replyToModifyPathName' ), // callable
                             $sFileContents // subject
                         );     
                     }
@@ -563,7 +563,7 @@ 
                     return strlen( $_sPrefix )
                         ? str_replace( 
                             'AdminPageFramework', // search 
-                            $_sPrefix . 'AdminPageFramework', // replace
+                            $_sPrefix.'AdminPageFramework', // replace
                             $sSubject // subject
                         )
                         : $sSubject;
@@ -595,7 +595,7 @@ 
                      */
                     private function _getFormSubmitValueByFieldIDAsString( $sFieldID ) {
                          
-                        static $_aCaches=array();
+                        static $_aCaches = array();
                         $_aCaches[ $sFieldID ] = isset( $_aCaches[ $sFieldID ] )
                             ? $_aCaches[ $sFieldID ]
                             : $this->oFactory->oUtil->getElement(
@@ -629,9 +629,9 @@ 
                 'public',
             ),
             'Content-Description'       => 'File Transfer',
-            'Content-type'              => 'application/octet-stream',   // 'application/zip' may work as well
+            'Content-type'              => 'application/octet-stream', // 'application/zip' may work as well
             'Content-Transfer-Encoding' => 'binary',
-            'Content-Disposition'       => 'attachment; filename="' . $sFileName .'";',
+            'Content-Disposition'       => 'attachment; filename="'.$sFileName.'";',
             // 'Content-Length'            => strlen( $mData ),
         ) + $aHeader;
         
@@ -668,10 +668,10 @@ 
         $_sFileNameWOExtension = trim( $_sFileNameWOExtension );
         return $this->oFactory->oUtil->getAOrB(
                 $_sFileNameWOExtension,
-                $_sFileNameWOExtension . '-admin-page-framework',
+                $_sFileNameWOExtension.'-admin-page-framework',
                 'admin-page-framework'
             )
-            . '.' . AdminPageFramework_Registry::VERSION
+            . '.'.AdminPageFramework_Registry::VERSION
             . '.zip';
         
     }

include/class/admin/admin-page-framework/tool/minifier/AdminPageFrameworkLoader_AdminPage_Tool_Minifier_Minifier.php

Doc Comments +1 added lines

@@ -139,6 +139,7 @@
          * Modifies the class names of the minified script.
          * 
          * @since       3.4.6
+         * @param string $sCode
          */
         private function _modifyClassNames( $sCode ) {
 

Spacing +9 added lines, -9 removed lines

@@ -26,7 +26,7 @@ 
             4 
         );
         add_action( 
-            'export_name_' . $this->sPageSlug . '_' . $this->sTabSlug, 
+            'export_name_'.$this->sPageSlug.'_'.$this->sTabSlug, 
             array( $this, 'replyToFilterFileName' ), 10, 5 
         );
         
@@ -41,7 +41,7 @@ 
                 'title'             => __( 'Class Prefix', 'admin-page-framework-loader' ),
                 'type'              => 'text',
                 'description'       => __( 'Set alphanumeric characters for the class names', 'admin-page-framework-loader' )
-                    . ' ' .  __( 'For example, if you set here <code>MyPluginName_</code>, you will need to extend the class named <code>MyClassName_AdminPageFramework</code> instead of <code>AdminPageFramework</code>.', 'admin-page-framework-loader' )
+                    . ' '.__( 'For example, if you set here <code>MyPluginName_</code>, you will need to extend the class named <code>MyClassName_AdminPageFramework</code> instead of <code>AdminPageFramework</code>.', 'admin-page-framework-loader' )
                     . ' e.g.<code>MyPluginName_</code>',
                 'attributes'        => array(
                     'size'          => 30,
@@ -68,8 +68,8 @@ 
                 'type'              => 'export',
                 'label_min_width'   => 0,
                 'value'             => __( 'Download', 'adimn-page-framework-demo' ),
-                'file_name'         => 'admin-page-framework.min.php',  // the default file name. This will be modified by the filter.
-                'format'            => 'text',  // 'json', 'text', 'array'      
+                'file_name'         => 'admin-page-framework.min.php', // the default file name. This will be modified by the filter.
+                'format'            => 'text', // 'json', 'text', 'array'      
                 'description'       => __( 'Download the minified version.', 'admin-page-framework-loader' ),
             ) 
         );          
@@ -101,13 +101,13 @@ 
         if ( $aInput[ 'class_prefix' ] && empty( $_aMatches ) ) {
       
             // $variable[ 'sectioni_id' ]['field_id']
-            $_aErrors['class_prefix'] = __( 'The prefix must consist of alphanumeric with underscores.', 'admin-page-framework-loader' );
+            $_aErrors[ 'class_prefix' ] = __( 'The prefix must consist of alphanumeric with underscores.', 'admin-page-framework-loader' );
             $_bVerified = false;
                     
         }
 
         /* 4. An invalid value is found. */
-        if ( ! $_bVerified ) {
+        if ( !$_bVerified ) {
 
             /* 4-1. Set the error array for the input fields. */
             $oAdminPage->setFieldErrors( $_aErrors );     
@@ -128,7 +128,7 @@ 
      */
     public function replyToDownloadMinifiedVersion( $aSavedData, $sSubmittedFieldID, $sSubmittedInputID, $oAdminPage ) {
         
-        $_sMinifiedVersionPath = AdminPageFrameworkLoader_Registry::$sDirPath . '/library/admin-page-framework.min.php';
+        $_sMinifiedVersionPath = AdminPageFrameworkLoader_Registry::$sDirPath.'/library/admin-page-framework.min.php';
         if ( file_exists( $_sMinifiedVersionPath ) ) {
             return $this->_modifyClassNames( file_get_contents( $_sMinifiedVersionPath ) );
         }
@@ -147,8 +147,8 @@ 
                 : '';             
             
             return str_replace( 
-                'AdminPageFramework',         // search 
-                $_sPrefix . 'AdminPageFramework',         // replace
+                'AdminPageFramework', // search 
+                $_sPrefix.'AdminPageFramework', // replace
                 $sCode // subject
             );
         

Braces +1 added lines, -1 removed lines

@@ -168,7 +168,7 @@
      * )      
      * </code>
      */
-    public function replyToFilterFileName( $sFileName, $sFieldID, $sInputID, $vExportingData, $oAdminPage ) { 
+    public function replyToFilterFileName( $sFileName, $sFieldID, $sInputID, $vExportingData, $oAdminPage ) {
 
         return isset( 
                 $_POST[ $this->oFactory->oProp->sOptionKey ][ $this->sSectionID ][ 'minified_script_name' ]