michaeluno / admin-page-framework

development/factory/admin_page/AdminPageFramework_Model_Menu.php

Doc Comments +1 added lines

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

Spacing +46 added lines, -46 removed lines

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

Braces +4 added lines, -4 removed lines

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

development/factory/post_type/AdminPageFramework_PostType_View.php

Doc Comments +1 added lines

@@ -112,6 +112,7 @@
              * 
              * @internal
              * @since       3.5.10
+             * @param string $sMenuKey
              * @return      void
              */
             private function _removeAddNewSidebarSubMenu( $sMenuKey, $sPostTypeSlug ) {

Spacing +23 added lines, -23 removed lines

@@ -76,7 +76,7 @@ 
             $this->_removeAddNewSidebarSubMenu(
                 is_string( $_bsShowInMenu )
                     ? $_bsShowInMenu
-                    : 'edit.php?post_type=' . $this->oProp->sPostType,
+                    : 'edit.php?post_type='.$this->oProp->sPostType,
                 $this->oProp->sPostType
             );
             
@@ -117,20 +117,20 @@ 
             private function _removeAddNewSidebarSubMenu( $sMenuKey, $sPostTypeSlug ) {
 
                 // Remove the default post type menu item.
-                if ( ! isset( $GLOBALS['submenu'][ $sMenuKey ] ) ) {
+                if ( !isset( $GLOBALS[ 'submenu' ][ $sMenuKey ] ) ) {
                     // logged-in users of an insufficient access level don't have the menu to be registered.
                     return; 
                 } 
                 
-                foreach ( $GLOBALS['submenu'][ $sMenuKey ] as $_iIndex => $_aSubMenu ) {
+                foreach ( $GLOBALS[ 'submenu' ][ $sMenuKey ] as $_iIndex => $_aSubMenu ) {
                                 
-                    if ( ! isset( $_aSubMenu[ 2 ] ) ) { 
+                    if ( !isset( $_aSubMenu[ 2 ] ) ) { 
                         continue; 
                     }
                     
                     // Remove the default Add New entry.
-                    if ( 'post-new.php?post_type=' . $sPostTypeSlug === $_aSubMenu[ 2 ] ) {
-                        unset( $GLOBALS['submenu'][ $sMenuKey ][ $_iIndex ] );
+                    if ( 'post-new.php?post_type='.$sPostTypeSlug === $_aSubMenu[ 2 ] ) {
+                        unset( $GLOBALS[ 'submenu' ][ $sMenuKey ][ $_iIndex ] );
                         continue;
                     }
                     
@@ -145,13 +145,13 @@ 
      */ 
     public function _replyToAddAuthorTableFilter() {
         
-        if ( ! $this->oProp->bEnableAuthorTableFileter ) { 
+        if ( !$this->oProp->bEnableAuthorTableFileter ) { 
             return; 
         }
         
         if ( 
-            ! ( isset( $_GET['post_type'] ) && post_type_exists( $_GET['post_type'] ) 
-            && in_array( strtolower( $_GET['post_type'] ), array( $this->oProp->sPostType ) ) ) 
+            !( isset( $_GET[ 'post_type' ] ) && post_type_exists( $_GET[ 'post_type' ] ) 
+            && in_array( strtolower( $_GET[ 'post_type' ] ), array( $this->oProp->sPostType ) ) ) 
         ) {
             return;
         }
@@ -161,7 +161,7 @@ 
                 'show_option_all'   => $this->oMsg->get( 'show_all_authors' ),
                 'show_option_none'  => false,
                 'name'              => 'author',
-                'selected'          => ! empty( $_GET[ 'author' ] ) 
+                'selected'          => !empty( $_GET[ 'author' ] ) 
                     ? $_GET[ 'author' ] 
                     : 0,
                 'include_selected'  => false,
@@ -187,9 +187,9 @@ 
             return;
         }
         
-        foreach ( get_object_taxonomies( $GLOBALS['typenow'] ) as $_sTaxonomySulg ) {
+        foreach ( get_object_taxonomies( $GLOBALS[ 'typenow' ] ) as $_sTaxonomySulg ) {
             
-            if ( ! in_array( $_sTaxonomySulg, $this->oProp->aTaxonomyTableFilters ) ) {
+            if ( !in_array( $_sTaxonomySulg, $this->oProp->aTaxonomyTableFilters ) ) {
                 continue;
             }
             
@@ -203,7 +203,7 @@ 
             // Echo the drop down list based on the passed array argument.
             wp_dropdown_categories( 
                 array(
-                    'show_option_all'   => $this->oMsg->get( 'show_all' ) . ' ' . $_oTaxonomy->label,
+                    'show_option_all'   => $this->oMsg->get( 'show_all' ).' '.$_oTaxonomy->label,
                     'taxonomy'          => $_sTaxonomySulg,
                     'name'              => $_oTaxonomy->name,
                     'orderby'           => 'name',
@@ -223,24 +223,24 @@ 
      * 
      * @internal
      */
-    public function _replyToGetTableFilterQueryForTaxonomies( $oQuery=null ) {
+    public function _replyToGetTableFilterQueryForTaxonomies( $oQuery = null ) {
         
         if ( 'edit.php' != $this->oProp->sPageNow ) { 
             return $oQuery; 
         }
         
-        if ( ! isset( $GLOBALS['typenow'] ) ) { 
+        if ( !isset( $GLOBALS[ 'typenow' ] ) ) { 
             return $oQuery; 
         }
 
-        foreach ( get_object_taxonomies( $GLOBALS['typenow'] ) as $sTaxonomySlug ) {
+        foreach ( get_object_taxonomies( $GLOBALS[ 'typenow' ] ) as $sTaxonomySlug ) {
             
-            if ( ! in_array( $sTaxonomySlug, $this->oProp->aTaxonomyTableFilters ) ) { 
+            if ( !in_array( $sTaxonomySlug, $this->oProp->aTaxonomyTableFilters ) ) { 
                 continue; 
             }
             
             $sVar = &$oQuery->query_vars[ $sTaxonomySlug ];
-            if ( ! isset( $sVar ) ) { 
+            if ( !isset( $sVar ) ) { 
                 continue; 
             }
             
@@ -268,14 +268,14 @@ 
         }
 
         // If the screen icon url is specified
-        if ( isset( $this->oProp->aPostTypeArgs['screen_icon'] ) && $this->oProp->aPostTypeArgs['screen_icon'] ) {
-            $this->oProp->sStyle .= $this->_getStylesForPostTypeScreenIcon( $this->oProp->aPostTypeArgs['screen_icon'] );
+        if ( isset( $this->oProp->aPostTypeArgs[ 'screen_icon' ] ) && $this->oProp->aPostTypeArgs[ 'screen_icon' ] ) {
+            $this->oProp->sStyle .= $this->_getStylesForPostTypeScreenIcon( $this->oProp->aPostTypeArgs[ 'screen_icon' ] );
         }
             
         $this->oProp->sStyle = $this->oUtil->addAndApplyFilters( $this, "style_{$this->oProp->sClassName}", $this->oProp->sStyle );
         
         // Print out the filtered styles.
-        if ( ! empty( $this->oProp->sStyle ) ) {
+        if ( !empty( $this->oProp->sStyle ) ) {
             echo "<style type='text/css' id='admin-page-framework-style-post-type'>" 
                 . $this->oProp->sStyle
                 . "</style>";     
@@ -326,10 +326,10 @@ 
      */
     public function _replyToFilterPostTypeContent( $sContent ) {
         
-        if ( ! is_singular() ) {
+        if ( !is_singular() ) {
             return $sContent;
         }
-        if ( ! is_main_query() ) {
+        if ( !is_main_query() ) {
             return $sContent;
         }
         global $post;

Braces +9 added lines, -9 removed lines

@@ -17,7 +17,7 @@ 
  * @package     AdminPageFramework
  * @subpackage  PostType
  */
-abstract class AdminPageFramework_PostType_View extends AdminPageFramework_PostType_Model {    
+abstract class AdminPageFramework_PostType_View extends AdminPageFramework_PostType_Model {
 
     /**
      * Sets up hooks.
@@ -29,7 +29,7 @@ 
         
         parent::__construct( $oProp );
                         
-        if ( $this->_isInThePage() ) {     
+        if ( $this->_isInThePage() ) {
     
             // Table filters
             add_action( 'restrict_manage_posts', array( $this, '_replyToAddAuthorTableFilter' ) );
@@ -124,7 +124,7 @@ 
                 
                 foreach ( $GLOBALS['submenu'][ $sMenuKey ] as $_iIndex => $_aSubMenu ) {
                                 
-                    if ( ! isset( $_aSubMenu[ 2 ] ) ) { 
+                    if ( ! isset( $_aSubMenu[ 2 ] ) ) {
                         continue; 
                     }
                     
@@ -145,7 +145,7 @@ 
      */ 
     public function _replyToAddAuthorTableFilter() {
         
-        if ( ! $this->oProp->bEnableAuthorTableFileter ) { 
+        if ( ! $this->oProp->bEnableAuthorTableFileter ) {
             return; 
         }
         
@@ -177,7 +177,7 @@ 
      */ 
     public function _replyToAddTaxonomyTableFilter() {
         
-        if ( $GLOBALS[ 'typenow' ] != $this->oProp->sPostType ) { 
+        if ( $GLOBALS[ 'typenow' ] != $this->oProp->sPostType ) {
             return; 
         }
         
@@ -225,22 +225,22 @@ 
      */
     public function _replyToGetTableFilterQueryForTaxonomies( $oQuery=null ) {
         
-        if ( 'edit.php' != $this->oProp->sPageNow ) { 
+        if ( 'edit.php' != $this->oProp->sPageNow ) {
             return $oQuery; 
         }
         
-        if ( ! isset( $GLOBALS['typenow'] ) ) { 
+        if ( ! isset( $GLOBALS['typenow'] ) ) {
             return $oQuery; 
         }
 
         foreach ( get_object_taxonomies( $GLOBALS['typenow'] ) as $sTaxonomySlug ) {
             
-            if ( ! in_array( $sTaxonomySlug, $this->oProp->aTaxonomyTableFilters ) ) { 
+            if ( ! in_array( $sTaxonomySlug, $this->oProp->aTaxonomyTableFilters ) ) {
                 continue; 
             }
             
             $sVar = &$oQuery->query_vars[ $sTaxonomySlug ];
-            if ( ! isset( $sVar ) ) { 
+            if ( ! isset( $sVar ) ) {
                 continue; 
             }
             

development/factory/widget/AdminPageFramework_Widget_Controller.php

Doc Comments +1 added lines

@@ -24,6 +24,7 @@
      * 
      * @since       3.2.0
      * @internal    
+     * @param AdminPageFramework_Property_Widget $oProp
      */
     function __construct( $oProp ) {
         

Indentation +16 added lines, -16 removed lines

@@ -44,22 +44,22 @@
     }
 
     /**
-    * The method for necessary set-ups.
-    * 
-    * <h4>Example</h4>
-    * <code>
-    *   public function setUp() {
-    *       $this->setArguments( 
-    *           array(
-    *               'description'   =>  __( 'This is a sample widget with built-in field types created by Admin Page Framework.', 'admin-page-framework-demo' ),
-    *           ) 
-    *       );
-    *   }  
-    * </code>
-    * 
-    * @abstract
-    * @since        3.2.0
-    */
+     * The method for necessary set-ups.
+     * 
+     * <h4>Example</h4>
+     * <code>
+     *   public function setUp() {
+     *       $this->setArguments( 
+     *           array(
+     *               'description'   =>  __( 'This is a sample widget with built-in field types created by Admin Page Framework.', 'admin-page-framework-demo' ),
+     *           ) 
+     *       );
+     *   }  
+     * </code>
+     * 
+     * @abstract
+     * @since        3.2.0
+     */
     public function setUp() {}    
       
     /**

Spacing +5 added lines, -5 removed lines

@@ -150,7 +150,7 @@ 
      * @since       3.2.0
      * @internal    Temporarily marked internal
      */
-    public function enqueueStyles( $aSRCs, $aCustomArgs=array() ) {     
+    public function enqueueStyles( $aSRCs, $aCustomArgs = array() ) {     
         if ( method_exists( $this->oResource, '_enqueueStyles' ) ) {
             return $this->oResource->_enqueueStyles( $aSRCs, array( $this->oProp->sPostType ), $aCustomArgs );
         }
@@ -163,7 +163,7 @@ 
      * @since       3.2.0
      * @internal    Temporarily marked internal
      */    
-    public function enqueueStyle( $sSRC, $aCustomArgs=array() ) {
+    public function enqueueStyle( $sSRC, $aCustomArgs = array() ) {
         if ( method_exists( $this->oResource, '_enqueueStyle' ) ) {
             return $this->oResource->_enqueueStyle( $sSRC, array( $this->oProp->sPostType ), $aCustomArgs );     
         }
@@ -176,7 +176,7 @@ 
      * @since       3.2.0
      * @internal    Temporarily marked internal
      */
-    public function enqueueScripts( $aSRCs, $aCustomArgs=array() ) {
+    public function enqueueScripts( $aSRCs, $aCustomArgs = array() ) {
         if ( method_exists( $this->oResource, '_enqueueScripts' ) ) {
             return $this->oResource->_enqueueScripts( $aSRCs, array( $this->oProp->sPostType ), $aCustomArgs );
         }
@@ -189,7 +189,7 @@ 
      * @since           3.2.0
      * @internal    Temporarily marked internal
      */
-    public function enqueueScript( $sSRC, $aCustomArgs=array() ) {    
+    public function enqueueScript( $sSRC, $aCustomArgs = array() ) {    
         if ( method_exists( $this->oResource, '_enqueueScript' ) ) {
             return $this->oResource->_enqueueScript( $sSRC, array( $this->oProp->sPostType ), $aCustomArgs );
         }
@@ -203,7 +203,7 @@ 
      * @since       3.2.0
      * @return      void
      */ 
-    protected function setArguments( array $aArguments=array() ) {
+    protected function setArguments( array $aArguments = array() ) {
         $this->oProp->aWidgetArguments = $aArguments;  
     }  
     

Braces +5 added lines, -4 removed lines

@@ -17,7 +17,7 @@ 
  * @package     AdminPageFramework
  * @subpackage  Widget
  */
-abstract class AdminPageFramework_Widget_Controller extends AdminPageFramework_Widget_View {    
+abstract class AdminPageFramework_Widget_Controller extends AdminPageFramework_Widget_View {
 
     /**
      * Sets up hooks and properties.
@@ -33,7 +33,8 @@ 
             
             // Other admin page framework factory classes uses wp_loaded hook but widget_init hook is called before that.
             // So we use widgets_init hook for this factory.
-            if ( did_action( 'widgets_init' ) ) {  // For the activation hook.
+            if ( did_action( 'widgets_init' ) ) {
+// For the activation hook.
                 $this->setup_pre();
             } {
                 add_action( 'widgets_init', array( $this, 'setup_pre' ) );     
@@ -150,7 +151,7 @@ 
      * @since       3.2.0
      * @internal    Temporarily marked internal
      */
-    public function enqueueStyles( $aSRCs, $aCustomArgs=array() ) {     
+    public function enqueueStyles( $aSRCs, $aCustomArgs=array() ) {
         if ( method_exists( $this->oResource, '_enqueueStyles' ) ) {
             return $this->oResource->_enqueueStyles( $aSRCs, array( $this->oProp->sPostType ), $aCustomArgs );
         }
@@ -189,7 +190,7 @@ 
      * @since           3.2.0
      * @internal    Temporarily marked internal
      */
-    public function enqueueScript( $sSRC, $aCustomArgs=array() ) {    
+    public function enqueueScript( $sSRC, $aCustomArgs=array() ) {
         if ( method_exists( $this->oResource, '_enqueueScript' ) ) {
             return $this->oResource->_enqueueScript( $sSRC, array( $this->oProp->sPostType ), $aCustomArgs );
         }

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

@@ -25,21 +25,21 @@ 
      * @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( 
                 'classname'     => 'admin_page_framework_widget',
                 '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.
@@ -49,7 +49,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' ];
         
@@ -72,9 +72,9 @@ 
 
         echo $_sContent;
         
-		echo $aArguments[ 'after_widget' ];
+        echo $aArguments[ 'after_widget' ];
 		
-	}
+    }
         /**
          * Returns the widget title.
          * 
@@ -103,7 +103,7 @@ 
             if ( ! $_sTitle ) {
                 return '';
             }
-           return $aArguments['before_title'] 
+            return $aArguments['before_title'] 
                 . $_sTitle 
             . $aArguments['after_title'];           
             
@@ -115,7 +115,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, 
@@ -128,14 +128,14 @@ 
             $this->oCaller
         );
  
-	}
+    }
     
     /**
      * Constructs the widget form.
      * 
      * @return      void
      */
-	public function form( $aFormData ) {
+    public function form( $aFormData ) {
 
         // Trigger the load() method and load_{...} actions. The user sets up the form.
         $this->oCaller->load( $this->oCaller );
@@ -193,7 +193,7 @@ 
             // $this->oCaller
         // );   
        
-	}
+    }
     
         /**
          * 

Spacing +22 added lines, -22 removed lines

@@ -24,7 +24,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( 
@@ -32,8 +32,8 @@ 
                 'description'   => '',  
             );
 		parent::__construct( 
-            $oCaller->oProp->sClassName,  // base id 
-            $sWidgetTitle,      // widget title
+            $oCaller->oProp->sClassName, // base id 
+            $sWidgetTitle, // widget title
             $aArguments         // widget arguments
         );
         $this->oCaller = $oCaller;
@@ -54,7 +54,7 @@ 
         
         $this->oCaller->oUtil->addAndDoActions( 
             $this->oCaller, 
-            'do_' . $this->oCaller->oProp->sClassName, 
+            'do_'.$this->oCaller->oProp->sClassName, 
             $this->oCaller
         );
        
@@ -85,7 +85,7 @@ 
          */
         private function _getTitle( array $aArguments, array $aFormData ) {
                 
-            if ( ! $this->oCaller->oProp->bShowWidgetTitle ) {
+            if ( !$this->oCaller->oProp->bShowWidgetTitle ) {
                 return '';
             }
             
@@ -99,12 +99,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' ];           
             
         }
             
@@ -120,7 +120,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,
@@ -140,7 +140,7 @@ 
         $this->oCaller->load( $this->oCaller );
         $this->oCaller->oUtil->addAndDoActions( 
             $this->oCaller, 
-            'load_' . $this->oCaller->oProp->sClassName, 
+            'load_'.$this->oCaller->oProp->sClassName, 
             $this->oCaller 
         );
 	        
@@ -149,9 +149,9 @@ 
       
         // Set up callbacks for field element outputs such as for name and it attributes.
         $this->oCaller->oProp->aFieldCallbacks = 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' ),
             // 'hfClass'       => array( $this, '_replyToAddClassSelector' ),
             // 'hfNameFlat'    => array( $this, '_replyToGetFlatFieldName' ), // @deprecated 3.6.0+ the same as the framework factory method.
@@ -185,12 +185,12 @@ 
             $_aParams      = func_get_args() + array( null, null, null );
             $aField        = $_aParams[ 1 ];
             
-            $_sSectionIndex = isset( $aField['section_id'], $aField['_section_index'] ) 
-                ? "[{$aField['_section_index']}]" 
+            $_sSectionIndex = isset( $aField[ 'section_id' ], $aField[ '_section_index' ] ) 
+                ? "[{$aField[ '_section_index' ]}]" 
                 : "";             
             $_sID           = $this->oCaller->isSectionSet( $aField )
-                ? $aField['section_id'] . "]" . $_sSectionIndex . "[" . $aField[ 'field_id' ]
-                : $aField['field_id'];
+                ? $aField[ 'section_id' ]."]".$_sSectionIndex."[".$aField[ 'field_id' ]
+                : $aField[ 'field_id' ];
             return $this->get_field_name( $_sID );
         
         }    
@@ -209,15 +209,15 @@ 
             $_sIndex = $this->oCaller->oUtil->getAOrB(
                 '0' !== $sIndex && empty( $sIndex ),
                 '',
-                "[" . $sIndex . "]"
+                "[".$sIndex."]"
             );                        
-            $_sSectionIndex = isset( $aField['section_id'], $aField['_section_index'] ) 
-                ? "[{$aField['_section_index']}]" 
+            $_sSectionIndex = isset( $aField[ 'section_id' ], $aField[ '_section_index' ] ) 
+                ? "[{$aField[ '_section_index' ]}]" 
                 : "";             
             $_sID           = $this->oCaller->isSectionSet( $aField )
-                ? $aField['section_id'] . "]" . $_sSectionIndex . "[" . $aField[ 'field_id' ]
+                ? $aField[ 'section_id' ]."]".$_sSectionIndex."[".$aField[ 'field_id' ]
                 : $aField[ 'field_id' ];
-            return $this->get_field_name( $_sID ) . $_sIndex;
+            return $this->get_field_name( $_sID ).$_sIndex;
             
         }
         

development/utility/AdminPageFramework_PluginBootstrap.php

Doc Comments +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
      * @param       string      $sPluginFilePath        The plugin file path.
      * @param       string      $sPluginHookPrefix      The plugin hook slug without underscore. This will be used to construct hook names.
      * @param       string      $sSetUpHook             The action hook name for the setUp callback. Default 'plugins_loaded'.
-     * @param       string      $iPriority              The priority. Set a lower number to get loader earlier. Default: `10`.
+     * @param       integer      $iPriority              The priority. Set a lower number to get loader earlier. Default: `10`.
      */
     public function __construct( $sPluginFilePath, $sPluginHookPrefix='', $sSetUpHook='plugins_loaded', $iPriority=10 ) {
         

Spacing +5 added lines, -5 removed lines

@@ -40,7 +40,7 @@ 
      * @param       string      $sSetUpHook             The action hook name for the setUp callback. Default 'plugins_loaded'.
      * @param       string      $iPriority              The priority. Set a lower number to get loader earlier. Default: `10`.
      */
-    public function __construct( $sPluginFilePath, $sPluginHookPrefix='', $sSetUpHook='plugins_loaded', $iPriority=10 ) {
+    public function __construct( $sPluginFilePath, $sPluginHookPrefix = '', $sSetUpHook = 'plugins_loaded', $iPriority = 10 ) {
         
         // Check if it has been loaded.
         if ( $this->_hasLoaded() ) {
@@ -76,7 +76,7 @@ 
         register_deactivation_hook( $this->sFilePath, array( $this, 'replyToPluginDeactivation' ) );
                  
         // 8. Schedule to load plugin specific components.
-        if ( ! $this->sSetUpHook || did_action( $this->sSetUpHook ) )  {
+        if ( !$this->sSetUpHook || did_action( $this->sSetUpHook ) ) {
             $this->_replyToLoadPluginComponents();
         } else {
             add_action( $this->sSetUpHook, array( $this, '_replyToLoadPluginComponents' ), $this->iPriority );
@@ -113,13 +113,13 @@ 
          */
         protected function _registerClasses() {
             
-            if ( ! class_exists( 'AdminPageFramework_RegisterClasses' ) ) {
+            if ( !class_exists( 'AdminPageFramework_RegisterClasses' ) ) {
                 return;
             }                        
             // Register classes
             new AdminPageFramework_RegisterClasses( 
-                $this->getScanningDirs(),   // scanning directory paths
-                array(),                    // autoloader options
+                $this->getScanningDirs(), // scanning directory paths
+                array(), // autoloader options
                 $this->getClasses()         // pre-generated class list
             );
                     

Braces +1 added lines, -1 removed lines

@@ -76,7 +76,7 @@
         register_deactivation_hook( $this->sFilePath, array( $this, 'replyToPluginDeactivation' ) );
                  
         // 8. Schedule to load plugin specific components.
-        if ( ! $this->sSetUpHook || did_action( $this->sSetUpHook ) )  {
+        if ( ! $this->sSetUpHook || did_action( $this->sSetUpHook ) ) {
             $this->_replyToLoadPluginComponents();
         } else {
             add_action( $this->sSetUpHook, array( $this, '_replyToLoadPluginComponents' ), $this->iPriority );

development/utility/AdminPageFramework_Requirement.php

Doc Comments +3 added lines

@@ -134,6 +134,7 @@ 
          * Returns a php warning if present.
          * @since       3.5.3
          * @internal
+         * @param string $sType
          * @return      string      The warning.
          */
         private function _getWarningByType( $sType ) {
@@ -226,6 +227,7 @@ 
              * if it returns non true (false), it stores the subject warning and returns the array holding the warnings.
              * 
              * @since       3.4.6
+             * @param string $sFuncName
              * @return      array           The warning array.
              */
             private function _getWarningsByFunctionName( $sFuncName, $aSubjects ) {
@@ -285,6 +287,7 @@ 
     /**
      * Deactivates the plugin.
      * @since       3.4.6
+     * @param string $sPluginFilePath
      */
     public function deactivatePlugin( $sPluginFilePath, $sMessage='', $bIsOnActivation=false ) {
         

Indentation +1 added lines, -1 removed lines

@@ -278,7 +278,7 @@
                     ?  "<strong>" . $this->_sScriptName . "</strong>:&nbsp;" 
                     : '';            
                 return $_sScripTitle
-                   . implode( '<br />', $_aWarnings );
+                    . implode( '<br />', $_aWarnings );
                 
             }
         

Spacing +24 added lines, -24 removed lines

@@ -76,12 +76,12 @@ 
      * 
      * @since       3.4.6
      */ 
-    public function __construct( array $aRequirements=array(), $sScriptName='' ) {
+    public function __construct( array $aRequirements = array(), $sScriptName = '' ) {
         
         // Avoid undefined index warnings.
         $aRequirements          = $aRequirements + $this->_aDefaultRequirements;    
         $aRequirements          = array_filter( $aRequirements, 'is_array' );
-        foreach( array( 'php', 'mysql', 'wordpress' ) as $_iIndex => $_sName ) {
+        foreach ( array( 'php', 'mysql', 'wordpress' ) as $_iIndex => $_sName ) {
             if ( isset( $aRequirements[ $_sName ] ) ) {
                 $aRequirements[ $_sName ] = $aRequirements[ $_sName ] + $this->_aDefaultRequirements[ $_sName ];
             }
@@ -105,9 +105,9 @@ 
         $_aWarnings = array();
         
         // PHP, WordPress, MySQL
-        $_aWarnings[] = $this->_getWarningByType( 'php' );
-        $_aWarnings[] = $this->_getWarningByType( 'wordpress' );
-        $_aWarnings[] = $this->_getWarningByType( 'mysql' );
+        $_aWarnings[ ] = $this->_getWarningByType( 'php' );
+        $_aWarnings[ ] = $this->_getWarningByType( 'wordpress' );
+        $_aWarnings[ ] = $this->_getWarningByType( 'mysql' );
         
         // Ensure necessary array elements.
         $this->_aRequirements = $this->_aRequirements + array(
@@ -120,10 +120,10 @@ 
         // Check the rest.
         $_aWarnings = array_merge(
             $_aWarnings,
-            $this->_checkFunctions( $this->_aRequirements['functions'] ),
-            $this->_checkClasses( $this->_aRequirements['classes'] ),
-            $this->_checkConstants( $this->_aRequirements['constants'] ),
-            $this->_checkFiles( $this->_aRequirements['files'] )
+            $this->_checkFunctions( $this->_aRequirements[ 'functions' ] ),
+            $this->_checkClasses( $this->_aRequirements[ 'classes' ] ),
+            $this->_checkConstants( $this->_aRequirements[ 'constants' ] ),
+            $this->_checkFiles( $this->_aRequirements[ 'files' ] )
         );
         
         $this->aWarnings = array_filter( $_aWarnings ); // drop empty elements.
@@ -137,7 +137,7 @@ 
          * @return      string      The warning.
          */
         private function _getWarningByType( $sType ) {
-            if ( ! isset( $this->_aRequirements[ $sType ][ 'version' ] ) ) {
+            if ( !isset( $this->_aRequirements[ $sType ][ 'version' ] ) ) {
                 return '';
             }
             if ( $this->_checkPHPVersion( $this->_aRequirements[ $sType ][ 'version' ] ) ) {
@@ -164,7 +164,7 @@ 
          * @since       3.4.6
          */
         private function _checkWordPressVersion( $sWordPressVersion ) {
-            return version_compare( $GLOBALS['wp_version'], $sWordPressVersion, ">=" );
+            return version_compare( $GLOBALS[ 'wp_version' ], $sWordPressVersion, ">=" );
         }
         
         /**
@@ -230,9 +230,9 @@ 
              */
             private function _getWarningsByFunctionName( $sFuncName, $aSubjects ) {
                 $_aWarnings = array();
-                foreach( $aSubjects as $_sSubject => $_sWarning ) {
-                    if ( ! call_user_func_array( $sFuncName, array( $_sSubject ) ) ) {
-                        $_aWarnings[] = sprintf( $_sWarning, $_sSubject );
+                foreach ( $aSubjects as $_sSubject => $_sWarning ) {
+                    if ( !call_user_func_array( $sFuncName, array( $_sSubject ) ) ) {
+                        $_aWarnings[ ] = sprintf( $_sWarning, $_sSubject );
                     }
                 }
                 return $_aWarnings;                
@@ -252,7 +252,7 @@ 
          */    
         public function _replyToPrintAdminNotices() {
             
-            $_aWarnings     = array_unique( $this->aWarnings );
+            $_aWarnings = array_unique( $this->aWarnings );
             if ( empty( $_aWarnings ) ) {
                 return;
             }
@@ -270,12 +270,12 @@ 
              */
             private function _getWarnings() {
 
-                $_aWarnings     = array_unique( $this->aWarnings );            
+                $_aWarnings = array_unique( $this->aWarnings );            
                 if ( empty( $_aWarnings ) ) {
                     return '';
                 }        
-                $_sScripTitle   = $this->_sScriptName 
-                    ?  "<strong>" . $this->_sScriptName . "</strong>:&nbsp;" 
+                $_sScripTitle = $this->_sScriptName 
+                    ? "<strong>".$this->_sScriptName."</strong>:&nbsp;" 
                     : '';            
                 return $_sScripTitle
                    . implode( '<br />', $_aWarnings );
@@ -286,12 +286,12 @@ 
      * Deactivates the plugin.
      * @since       3.4.6
      */
-    public function deactivatePlugin( $sPluginFilePath, $sMessage='', $bIsOnActivation=false ) {
+    public function deactivatePlugin( $sPluginFilePath, $sMessage = '', $bIsOnActivation = false ) {
         
         add_action( 'admin_notices', array( $this, '_replyToPrintAdminNotices' ) );
-        $this->aWarnings[] = '<strong>' . $sMessage . '</strong>';
-        if ( ! function_exists( 'deactivate_plugins' ) ) {
-            if ( ! @include( ABSPATH . '/wp-admin/includes/plugin.php' ) ) {
+        $this->aWarnings[ ] = '<strong>'.$sMessage.'</strong>';
+        if ( !function_exists( 'deactivate_plugins' ) ) {
+            if ( !@include( ABSPATH.'/wp-admin/includes/plugin.php' ) ) {
                 return;
             }
         }
@@ -301,8 +301,8 @@ 
         // Before that, we can display messages to the user.
         if ( $bIsOnActivation ) {
             
-            $_sPluginListingPage = add_query_arg( array(), $GLOBALS['pagenow'] );
-            wp_die( $this->_getWarnings() . "<p><a href='$_sPluginListingPage'>Go back</a>.</p>" );
+            $_sPluginListingPage = add_query_arg( array(), $GLOBALS[ 'pagenow' ] );
+            wp_die( $this->_getWarnings()."<p><a href='$_sPluginListingPage'>Go back</a>.</p>" );
             
         }
         

Braces +1 added lines, -1 removed lines

@@ -100,7 +100,7 @@
      * @since       3.4.6
      * @return      integer         The number of warnings.
      */
-    public function check() {      
+    public function check() {
         
         $_aWarnings = array();
         

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 +3 added lines, -3 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 );

Braces +1 added lines, -1 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,

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

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 
@@ -76,7 +76,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,
@@ -126,8 +126,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' ),
@@ -181,8 +181,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 ) ) {
@@ -190,13 +190,13 @@ 
             $_bVerified = false;
         }
                         
-        if ( ! $aInput[ 'text_domain' ] ) {
+        if ( !$aInput[ 'text_domain' ] ) {
             $_aErrors[ '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;
@@ -238,8 +238,8 @@ 
      */
     public function replyToDownloadFramework( $aSavedData, $sSubmittedFieldID, $sSubmittedInputID, $oAdminPage ) {
         
-        $_sFrameworkDirPath = AdminPageFrameworkLoader_Registry::$sDirPath . '/library/admin-page-framework';
-        if ( ! file_exists( $_sFrameworkDirPath ) ) {
+        $_sFrameworkDirPath = AdminPageFrameworkLoader_Registry::$sDirPath.'/library/admin-page-framework';
+        if ( !file_exists( $_sFrameworkDirPath ) ) {
             return $aSavedData;
         }
         
@@ -248,7 +248,7 @@ 
             $_sFrameworkDirPath, 
             $_sTempFile
         );
-        header( "Content-Length: " . strlen( $_sData ) ); 
+        header( "Content-Length: ".strlen( $_sData ) ); 
         unlink( $_sTempFile );
         return $_sData;
         
@@ -265,9 +265,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 
                     ),
                 ),                
@@ -278,7 +278,7 @@ 
                 ) 
             );
             $_bSucceed = $_oZip->compress();
-            if ( ! $_bSucceed ) {
+            if ( !$_bSucceed ) {
                 return '';
             }
             return file_get_contents( $sDestinationPath );
@@ -298,7 +298,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;
                            
@@ -317,7 +317,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
@@ -386,7 +386,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(
@@ -440,7 +440,7 @@ 
             public function _replyToModifyFileContents( $sFileContents, $sPathInArchive ) {
 
                 $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(
@@ -454,7 +454,7 @@ 
                 );
             
                 // Check the file extension.
-                if ( ! in_array( pathinfo( $sPathInArchive, PATHINFO_EXTENSION ), array( 'php', 'css', 'js' ) ) ) {
+                if ( !in_array( pathinfo( $sPathInArchive, PATHINFO_EXTENSION ), array( 'php', 'css', 'js' ) ) ) {
                     return $sFileContents;
                 }
                 
@@ -506,12 +506,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
                         );      
@@ -525,14 +525,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
                         );     
                     }
@@ -557,7 +557,7 @@ 
                     return strlen( $_sPrefix )
                         ? str_replace( 
                             'AdminPageFramework', // search 
-                            $_sPrefix . 'AdminPageFramework', // replace
+                            $_sPrefix.'AdminPageFramework', // replace
                             $sSubject // subject
                         )
                         : $sSubject;
@@ -589,7 +589,7 @@ 
                      */
                     private function _getFormSubmitValueByFieldIDAsString( $sFieldID ) {
                          
-                        static $_aCaches=array();
+                        static $_aCaches = array();
                         $_aCaches[ $sFieldID ] = isset( $_aCaches[ $sFieldID ] )
                             ? $_aCaches[ $sFieldID ]
                             : $this->oFactory->oUtil->getElement(
@@ -623,9 +623,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;
         
@@ -662,10 +662,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';
         
     }

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' ] 

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' ]