michaeluno / admin-page-framework

development/factory/_common/utility/base_utility/AdminPageFramework_Utility_String.php

Doc Comments +4 added lines, -2 removed lines

@@ -36,7 +36,7 @@ 
      * Converts non-alphabetic characters to underscore.
      * 
      * @since       2.0.0
-     * @return      string|null     The sanitized string.
+     * @return      string     The sanitized string.
      * @todo        Change the method name as it does not tell for what it will sanitized.
      * @todo        Examine why null needs to be returned.
      */ 
@@ -119,7 +119,7 @@ 
     /**
      * Returns the given string length.
      * @since       3.3.0
-     * @return      integer|null        Null if an array is given.
+     * @return      integer        Null if an array is given.
      */
     static public function getStringLength( $sString ) {
         return function_exists( 'mb_strlen' )
@@ -176,6 +176,8 @@ 
     }
     /**
      * Trims a traling sub-string if exists.
+     * @param string $sString
+     * @param string $sSuffix
      * @return      string
      * @since       3.7.2
      */

Spacing +9 added lines, -9 removed lines

@@ -26,9 +26,9 @@ 
      * @since       3.1.1
      * @return      string
      */
-    static public function sanitizeLength( $sLength, $sUnit='px' ) {
+    static public function sanitizeLength( $sLength, $sUnit = 'px' ) {
         return is_numeric( $sLength )
-            ? $sLength . $sUnit
+            ? $sLength.$sUnit
             : $sLength;
     }
   
@@ -71,9 +71,9 @@ 
      * @since       2.0.0
      * @return      string|integer      A numeric value will be returned. 
      */
-    static public function fixNumber( $nToFix, $nDefault, $nMin='', $nMax='' ) {
+    static public function fixNumber( $nToFix, $nDefault, $nMin = '', $nMax = '' ) {
 
-        if ( ! is_numeric( trim( $nToFix ) ) ) {
+        if ( !is_numeric( trim( $nToFix ) ) ) {
             return $nDefault;
         }
         if ( $nMin !== '' && $nToFix < $nMin ) {
@@ -96,7 +96,7 @@ 
      */
     static public function getCSSMinified( $sCSSRules ) {
         return str_replace(
-            array( "\r\n", "\r", "\n", "\t", '  ', '    ', '    '),  // remove line breaks, tab, and white sspaces.
+            array( "\r\n", "\r", "\n", "\t", '  ', '    ', '    ' ), // remove line breaks, tab, and white sspaces.
             '',
             preg_replace( '!/\*[^*]*\*+([^/][^*]*\*+)*/!', '', $sCSSRules ) // remove comments
         );
@@ -106,7 +106,7 @@ 
          */
         static public function minifyCSS( $sCSSRules ) {
             trigger_error(
-                AdminPageFramework_Registry::NAME . ': ' . sprintf(
+                AdminPageFramework_Registry::NAME.': '.sprintf(
                     'The method, %1$s, is deprecated. Use %2$s instead.',
                     'minifyCSS()',
                     'getCSSMinified()'
@@ -136,8 +136,8 @@ 
      */
     static public function getNumberOfReadableSize( $nSize ) {
         
-        $_nReturn     = substr( $nSize, 0, -1 );
-        switch( strtoupper( substr( $nSize, -1 ) ) ) {
+        $_nReturn = substr( $nSize, 0, -1 );
+        switch ( strtoupper( substr( $nSize, -1 ) ) ) {
             case 'P':
                 $_nReturn *= 1024;
             case 'T':
@@ -165,7 +165,7 @@ 
         $_iPower    = ( int ) $_nLog;
         $_iSize     = pow( 1024, $_nLog - $_iPower );
 
-        return $_iSize . $_aUnits[ $_iPower ];
+        return $_iSize.$_aUnits[ $_iPower ];
     }
 
     /**

development/factory/_common/utility/base_utility/AdminPageFramework_Utility_SystemInformation.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
      * Returns an array of constants.
      * 
      * @since       3.4.6
-     * @param       array|string      $asCategory      The category key names of the returning array.
+     * @param       array|string      $asCategories      The category key names of the returning array.
      */
     static public function getDefinedConstants( $asCategories=null, $asRemovingCategories=null ) {
         

Spacing +11 added lines, -11 removed lines

@@ -41,7 +41,7 @@ 
         $_sOutput = preg_replace(
             array(
                 '#^.*<body>(.*)</body>.*$#ms', '#<h2>PHP License</h2>.*$#ms',
-                '#<h1>Configuration</h1>#',  "#\r?\n#", "#</(h1|h2|h3|tr)>#", '# +<#',
+                '#<h1>Configuration</h1>#', "#\r?\n#", "#</(h1|h2|h3|tr)>#", '# +<#',
                 "#[ \t]+#", '#&nbsp;#', '#  +#', '# class=".*?"#', '%&#039;%',
                 '#<tr>(?:.*?)" src="(?:.*?)=(.*?)" alt="PHP Logo" /></a>'
                     .'<h1>PHP Version (.*?)</h1>(?:\n+?)</td></tr>#',
@@ -52,11 +52,11 @@ 
                 '#</tr>#',
             ),
             array(
-                '$1', '', '', '', '</$1>' . "\n", '<', ' ', ' ', ' ', '', ' ',
+                '$1', '', '', '', '</$1>'."\n", '<', ' ', ' ', ' ', '', ' ',
                 '<h2>PHP Configuration</h2>'."\n".'<tr><td>PHP Version</td><td>$2</td></tr>'.
                 "\n".'<tr><td>PHP Egg</td><td>$1</td></tr>',
                 '<tr><td>PHP Credits Egg</td><td>$1</td></tr>',
-                '<tr><td>Zend Engine</td><td>$2</td></tr>' . "\n" . '<tr><td>Zend Egg</td><td>$1</td></tr>',
+                '<tr><td>Zend Engine</td><td>$2</td></tr>'."\n".'<tr><td>Zend Egg</td><td>$1</td></tr>',
                 ' ',
                 '%S%',
                 '%E%',
@@ -68,7 +68,7 @@ 
         unset( $_aSections[ 0 ] );
 
         $_aOutput = array();
-        foreach( $_aSections as $_sSection ) {
+        foreach ( $_aSections as $_sSection ) {
             $_iIndex = substr( $_sSection, 0, strpos( $_sSection, '</h2>' ) );
             preg_match_all(
                 '#%S%(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?(?:<td>(.*?)</td>)?%E%#',
@@ -76,12 +76,12 @@ 
                 $_aAskApache,
                 PREG_SET_ORDER
             );
-            foreach( $_aAskApache as $_aMatches ) {
-                if ( ! isset( $_aMatches[ 1 ], $_aMatches[ 2 ] ) ) {
+            foreach ( $_aAskApache as $_aMatches ) {
+                if ( !isset( $_aMatches[ 1 ], $_aMatches[ 2 ] ) ) {
                     array_slice( $_aMatches, 2 );
                     continue;
                 }
-                $_aOutput[ $_iIndex ][ $_aMatches[ 1 ] ] = ! isset( $_aMatches[ 3 ] ) || $_aMatches[ 2 ] == $_aMatches[ 3 ]
+                $_aOutput[ $_iIndex ][ $_aMatches[ 1 ] ] = !isset( $_aMatches[ 3 ] ) || $_aMatches[ 2 ] == $_aMatches[ 3 ]
                     ? $_aMatches[ 2 ]
                     : array_slice( $_aMatches, 2 );
             }
@@ -98,7 +98,7 @@ 
      * @since       3.4.6
      * @param       array|string      $asCategory      The category key names of the returning array.
      */
-    static public function getDefinedConstants( $asCategories=null, $asRemovingCategories=null ) {
+    static public function getDefinedConstants( $asCategories = null, $asRemovingCategories = null ) {
         
         $_aCategories           = is_array( $asCategories ) ? $asCategories : array( $asCategories );
         $_aCategories           = array_filter( $_aCategories );
@@ -127,8 +127,8 @@ 
                 
         $_aPHPInfo = self::getPHPInfo();
 
-        return isset( $_aPHPInfo['PHP Core']['error_log'] )
-            ? $_aPHPInfo['PHP Core']['error_log']
+        return isset( $_aPHPInfo[ 'PHP Core' ][ 'error_log' ] )
+            ? $_aPHPInfo[ 'PHP Core' ][ 'error_log' ]
             : '';
         
     }
@@ -137,7 +137,7 @@ 
      * Returns a PHP error log.
      * @since       3.4.6
      */
-    static public function getPHPErrorLog( $iLines=1 ) {
+    static public function getPHPErrorLog( $iLines = 1 ) {
         
         $_sLog = self::getFileTailContents( self::getPHPErrorLogPath(), $iLines );
         

development/factory/_common/utility/base_utility/AdminPageFramework_Utility_URL.php

Doc Comments +2 added lines

@@ -23,6 +23,7 @@ 
      * 
      * @since       2.0.0
      * @since       3.5.7       Moved from `AdminPageFramework_Utility`.
+     * @param string $sQueryKey
      * @return      string|null
      */ 
     static public function getQueryValueInURLByKey( $sURL, $sQueryKey ) {
@@ -72,6 +73,7 @@ 
         /**
          * Returns the port suffix in the currently loading url.
          * @since       3.5.7
+         * @param boolean $_bSSL
          * @return      string
          */
         static private function _getURLPortSuffix( $_bSSL ) {

Spacing +4 added lines, -4 removed lines

@@ -52,7 +52,7 @@ 
             0 => '',
             1 => 's',
         );
-        $_sProtocol         = substr( $_sServerProtocol, 0, strpos( $_sServerProtocol, '/' ) )
+        $_sProtocol = substr( $_sServerProtocol, 0, strpos( $_sServerProtocol, '/' ) )
             . $_aProrocolSuffix[ ( int ) $_bSSL ];
         
         // Port: e.g. :80
@@ -66,7 +66,7 @@ 
                 : $_SERVER[ 'SERVER_NAME' ] 
             );
             
-        return $_sProtocol . '://' . $_sHost . $_sPort . $_SERVER[ 'REQUEST_URI' ];
+        return $_sProtocol.'://'.$_sHost.$_sPort.$_SERVER[ 'REQUEST_URI' ];
         
     }
         /**
@@ -79,10 +79,10 @@ 
                 ? ( string ) $_SERVER[ 'SERVER_PORT' ]
                 : '';
             $_aPort     = array(
-                0 => ':' . $_sPort,
+                0 => ':'.$_sPort,
                 1 => '',
             );
-            $_bPortSet  = ( ! $_bSSL && '80' === $_sPort ) || ( $_bSSL && '443' === $_sPort );
+            $_bPortSet = ( !$_bSSL && '80' === $_sPort ) || ( $_bSSL && '443' === $_sPort );
             return $_aPort[ ( int ) $_bPortSet ];
         }
     

development/factory/_common/utility/wp_utility/AdminPageFramework_WPUtility_Hook.php

Doc Comments +1 added lines, -9 removed lines

@@ -89,11 +89,6 @@ 
      * @access      public
      * @since       2.0.0
      * @remark      Accepts variadic parameters.
-     * @param       object      $oCallerObject      the object that holds the callback method that matches the action hook name.
-     * @param       array       $aActionHooks       a numerically index array consisting of action hook names that serve as the callback method names. 
-     * @param       mixed       $vArgs1             the argument to pass to the hook callback functions.
-     * @param       mixed       $vArgs2             another argument to pass to the hook callback functions.
-     * @param       mixed       $_and_more          add as many arguments as necessary to the next parameters.
      * @return      void
      */ 
     static public function addAndDoActions( /* $oCallerObject, $aActionHooks, $vArgs1=null, $vArgs2=null, $_and_more=null */ ) {
@@ -192,10 +187,6 @@ 
      * `
      * 
      * @since       2.0.0
-     * @param       object      $oCallerObject
-     * @param       string      $sFilter            The filter hook name.
-     * @param       mixed       $vData              The filtering data
-     * @param       mixed       $vArgs              The arguments.
      */
     static public function addAndApplyFilter( /* $oCallerObject, $sFilter, $vData, $vArgs... */ ) { 
         
@@ -233,6 +224,7 @@ 
      * 
      * @since       2.0.0
      * @access      public
+     * @param string $sPrefix
      * @return      array       Returns an array consisting of the filters.
      */ 
     static public function getFilterArrayByPrefix( $sPrefix, $sClassName, $sPageSlug, $sTabSlug, $bReverse=false ) {

Spacing +17 added lines, -17 removed lines

@@ -26,7 +26,7 @@ 
      * @since       3.4.2
      * @todo        Create a similar function for filters.
      */
-    static public function registerAction( $sActionHook, $oCallable, $iPriority=10 ) {
+    static public function registerAction( $sActionHook, $oCallable, $iPriority = 10 ) {
       
         if ( did_action( $sActionHook ) ) {
             return call_user_func_array( $oCallable, array() );
@@ -63,13 +63,13 @@ 
      * @param       mixed       $_and_more      add as many arguments as necessary to the next parameters.
      * @return      void        does not return a value.
      */
-    static public function doActions( $aActionHooks, $vArgs1=null, $vArgs2=null, $_and_more=null ) {
+    static public function doActions( $aActionHooks, $vArgs1 = null, $vArgs2 = null, $_and_more = null ) {
         
         $aArgs          = func_get_args();
         $aActionHooks   = $aArgs[ 0 ];
-        foreach( ( array ) $aActionHooks as $sActionHook  ) {
+        foreach ( ( array ) $aActionHooks as $sActionHook ) {
             $aArgs[ 0 ] = $sActionHook;
-            call_user_func_array( 'do_action' , $aArgs );
+            call_user_func_array( 'do_action', $aArgs );
         }
 
     }
@@ -101,12 +101,12 @@ 
         $aArgs          = func_get_args();
         $oCallerObject  = $aArgs[ 0 ];
         $aActionHooks   = $aArgs[ 1 ];
-        foreach( ( array ) $aActionHooks as $sActionHook ) {
-            if ( ! $sActionHook ) {
+        foreach ( ( array ) $aActionHooks as $sActionHook ) {
+            if ( !$sActionHook ) {
                 continue;
             }
             $aArgs[ 1 ] = $sActionHook;
-            call_user_func_array( array( get_class(), 'addAndDoAction' ) , $aArgs );
+            call_user_func_array( array( get_class(), 'addAndDoAction' ), $aArgs );
         }
         
     }
@@ -125,7 +125,7 @@ 
         $_aArgs          = func_get_args();
         $_oCallerObject  = $_aArgs[ 0 ];
         $_sActionHook    = $_aArgs[ 1 ];
-        if ( ! $_sActionHook ) {
+        if ( !$_sActionHook ) {
             return;
         }
         
@@ -137,7 +137,7 @@ 
 
         // Remove the first element, the caller object.
         array_shift( $_aArgs );
-        call_user_func_array( 'do_action' , $_aArgs );
+        call_user_func_array( 'do_action', $_aArgs );
         
     }
     
@@ -165,12 +165,12 @@ 
         $_aFilters      = $_aArgs[ 1 ];
         $_vInput        = $_aArgs[ 2 ];
 
-        foreach( ( array ) $_aFilters as $_sFilter ) {
-            if ( ! $_sFilter ) {
+        foreach ( ( array ) $_aFilters as $_sFilter ) {
+            if ( !$_sFilter ) {
                 continue;
             }
             $_aArgs[ 1 ] = $_sFilter;
-            $_aArgs[ 2 ] = $_vInput;    // assigns the updated value as it is filtered in previous iterations
+            $_aArgs[ 2 ] = $_vInput; // assigns the updated value as it is filtered in previous iterations
             $_vInput = call_user_func_array(
                 array( get_class(), 'addAndApplyFilter' ),
                 $_aArgs
@@ -205,7 +205,7 @@ 
         $_aArgs          = func_get_args();
         $_oCallerObject  = $_aArgs[ 0 ];
         $_sFilter        = $_aArgs[ 1 ];
-        if ( ! $_sFilter ) {
+        if ( !$_sFilter ) {
             return $_aArgs[ 2 ];
         }
         
@@ -237,17 +237,17 @@ 
      * @access      public
      * @return      array       Returns an array consisting of the filters.
      */
-    static public function getFilterArrayByPrefix( $sPrefix, $sClassName, $sPageSlug, $sTabSlug, $bReverse=false ) {
+    static public function getFilterArrayByPrefix( $sPrefix, $sClassName, $sPageSlug, $sTabSlug, $bReverse = false ) {
                 
         $_aFilters = array();
         if ( $sTabSlug && $sPageSlug ) {
-            $_aFilters[] = "{$sPrefix}{$sPageSlug}_{$sTabSlug}";
+            $_aFilters[ ] = "{$sPrefix}{$sPageSlug}_{$sTabSlug}";
         }
         if ( $sPageSlug ) {
-            $_aFilters[] = "{$sPrefix}{$sPageSlug}";
+            $_aFilters[ ] = "{$sPrefix}{$sPageSlug}";
         }
         if ( $sClassName ) {
-            $_aFilters[] = "{$sPrefix}{$sClassName}";
+            $_aFilters[ ] = "{$sPrefix}{$sClassName}";
         }
 
         return $bReverse

development/factory/_common/utility/wp_utility/AdminPageFramework_WPUtility_Page.php

Doc Comments +1 added lines

@@ -284,6 +284,7 @@
              * Checkes whether the passed base url name is of the admin index page.
              * @since       3.5.3
              * return       boolean      Whether the passed base url name is of the admin index page.
+             * @param string $sPageNow
              */
             static private function _isInAdminIndex( $sPageNow ) {
                 return in_array(

Spacing +11 added lines, -11 removed lines

@@ -58,7 +58,7 @@ 
                 'getPostTypeByTypeNow',
                 'getPostTypeByScreenObject',
                 'getPostTypeByREQUEST',
-                'getPostTypeByPostObject',  // 3.6.0+ Moved to the last as it is not reliable.
+                'getPostTypeByPostObject', // 3.6.0+ Moved to the last as it is not reliable.
             );
             foreach ( $_aMethodsToTry as $_sMethodName ) {
                 $_sPostType = call_user_func( array( __CLASS__, $_sMethodName ) );
@@ -123,9 +123,9 @@ 
      * @param       array|string        The post type slug(s) to check. If this is empty, the method just checks the current page is a taxonomy page.
      * @return      boolean
      */
-    static public function isCustomTaxonomyPage( $asPostTypes=array() ) {
+    static public function isCustomTaxonomyPage( $asPostTypes = array() ) {
         
-        if ( ! in_array( self::getPageNow(), array( 'tags.php', 'edit-tags.php', ) ) ) {
+        if ( !in_array( self::getPageNow(), array( 'tags.php', 'edit-tags.php',) ) ) {
             return false;
         }
 
@@ -141,10 +141,10 @@ 
      * Otherwise, it will check if the page belongs to the given post type(s).
      * @return      boolean
      */
-    static public function isPostDefinitionPage( $asPostTypes=array() ) {
+    static public function isPostDefinitionPage( $asPostTypes = array() ) {
         
         // If it's not the post definition page, 
-        if ( ! in_array( self::getPageNow(), array( 'post.php', 'post-new.php', ) ) ) {
+        if ( !in_array( self::getPageNow(), array( 'post.php', 'post-new.php',) ) ) {
             return false;
         }
 
@@ -178,7 +178,7 @@ 
      * 
      * @since 3.0.0
      */
-    static public function isPostListingPage( $asPostTypes=array() ) {
+    static public function isPostListingPage( $asPostTypes = array() ) {
                 
         if ( 'edit.php' != self::getPageNow() ) {
             return false;
@@ -186,7 +186,7 @@ 
         
         $_aPostTypes = self::getAsArray( $asPostTypes );
         
-        if ( ! isset( $_GET[ 'post_type' ] )  ) {
+        if ( !isset( $_GET[ 'post_type' ] ) ) {
             return in_array( 'post', $_aPostTypes );
         }
 
@@ -225,7 +225,7 @@ 
             0 => '_getPageNow_FrontEnd',
             1 => '_getPageNow_BackEnd',
         );
-        $_sMethodName  = $_aMethodNames[ ( integer ) is_admin() ];
+        $_sMethodName = $_aMethodNames[ ( integer ) is_admin() ];
         self::$_sPageNow = self::$_sMethodName();
 
         return self::$_sPageNow;
@@ -324,7 +324,7 @@ 
         
         if ( isset( $GLBOALS[ 'page_hook' ] ) ) {
             return is_network_admin()
-                ? $GLBOALS[ 'page_hook' ] . '-network'
+                ? $GLBOALS[ 'page_hook' ].'-network'
                 : $GLBOALS[ 'page_hook' ];
         }
         
@@ -338,11 +338,11 @@ 
      * @since       3.7.0
      * @return      boolean
      */
-    static public function doesMetaBoxExist( $sContext='' ) {
+    static public function doesMetaBoxExist( $sContext = '' ) {
         
         $_aDimensions = array( 'wp_meta_boxes', $GLOBALS[ 'page_hook' ] );
         if ( $sContext ) {
-            $_aDimensions[] = $sContext;
+            $_aDimensions[ ] = $sContext;
         }
         $_aSideMetaBoxes = self::getElementAsArray(
             $GLOBALS,

Braces +2 added lines, -4 removed lines

@@ -281,11 +281,9 @@
                 
                 if ( is_network_admin() ) {
                     $_sNeedle = '#/wp-admin/network/?(.*?)$#i';
-                }
-                else if ( is_user_admin() ) {
+                } else if ( is_user_admin() ) {
                     $_sNeedle = '#/wp-admin/user/?(.*?)$#i';
-                }
-                else {
+                } else {
                     $_sNeedle = '#/wp-admin/?(.*?)$#i';
                 }
                 preg_match( $_sNeedle, $_SERVER[ 'PHP_SELF' ], $_aMatches );

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

Doc Comments +4 added lines, -1 removed lines

@@ -27,6 +27,7 @@ 
      * Sets up hooks
      * 
      * @internal
+     * @param AdminPageFramework_Model_Menu $oFactory
      */
     public function __construct( $oFactory, $sActionHook='admin_menu' ) {
         
@@ -228,6 +229,7 @@ 
              * @since       3.3.0
              * @since       3.1.1       Moved from `AdminPageFramework_Menu`.
              * @since       3.7.4       Added the `$nOrder` parameter.
+             * @param string $sMenuSlug
              * @return      string      The page hook of the added page.
              * @uses        add_submenu_page
              */
@@ -340,7 +342,7 @@ 
                 /**
                  * @since       3.7.4
                  * @return      void
-                 * @param       numeric     $$nOrder            A user set order (menu position, index).
+                 * @param       numeric     $nOrder            A user set order (menu position, index).
                  * @param       array       $aSubMenuItem       The sub menu item array set in the global `$submenu` array.
                  */
                 private function _setSubMenuPageByIndex( $nOrder, $aSubMenuItem, $sMenuSlug ) {
@@ -464,6 +466,7 @@ 
              * @since       3.1.1       Moved from `AdminPageFramework_Menu`.
              * @since       3.5.3       Added the `$bShowInMenu` parameter.
              * @since       3.7.4       Added the `$nOrder` parameter.
+             * @param string $sMenuSlug
              * @return      void
              */
             private function _addLinkSubmenuItem( $sMenuSlug, $sTitle, $sCapability, $sHref, $bShowInMenu, $nOrder ) {

Spacing +33 added lines, -33 removed lines

@@ -28,7 +28,7 @@ 
      * 
      * @internal
      */
-    public function __construct( $oFactory, $sActionHook='admin_menu' ) {
+    public function __construct( $oFactory, $sActionHook = 'admin_menu' ) {
         
         $this->oFactory = $oFactory;
         
@@ -71,8 +71,8 @@ 
         
         // Apply filters to let other scripts add sub menu pages.
         $this->oFactory->oProp->aPages = $this->addAndApplyFilter(
-            $this->oFactory,    // caller object
-            "pages_{$this->oFactory->oProp->sClassName}",   // filter
+            $this->oFactory, // caller object
+            "pages_{$this->oFactory->oProp->sClassName}", // filter
             $this->oFactory->oProp->aPages  // arguments
         );
         
@@ -120,7 +120,7 @@ 
 
             foreach ( $this->oFactory->oProp->aPages as $_aPage ) {
                 
-                if ( ! isset( $_aPage[ 'page_slug' ] ) ) {
+                if ( !isset( $_aPage[ 'page_slug' ] ) ) {
                     continue;
                 }
                 $this->oFactory->oProp->sDefaultPageSlug = $_aPage[ 'page_slug' ];
@@ -141,12 +141,12 @@ 
         private function _registerRootMenuPage() {
 
             $this->oFactory->oProp->aRootMenu[ '_page_hook' ] = add_menu_page(
-                $this->oFactory->oProp->sClassName,                 // Page title - will be invisible anyway
-                $this->oFactory->oProp->aRootMenu[ 'sTitle' ],      // Menu title - should be the root page title.
-                $this->oFactory->oProp->sCapability,                // Capability - access right
-                $this->oFactory->oProp->aRootMenu[ 'sPageSlug' ],   // Menu ID 
-                '',                                       // Callback function for the page content output - the root page will be removed so no need to register a function.
-                $this->oFactory->oProp->aRootMenu[ 'sIcon16x16' ],  // icon path
+                $this->oFactory->oProp->sClassName, // Page title - will be invisible anyway
+                $this->oFactory->oProp->aRootMenu[ 'sTitle' ], // Menu title - should be the root page title.
+                $this->oFactory->oProp->sCapability, // Capability - access right
+                $this->oFactory->oProp->aRootMenu[ 'sPageSlug' ], // Menu ID 
+                '', // Callback function for the page content output - the root page will be removed so no need to register a function.
+                $this->oFactory->oProp->aRootMenu[ 'sIcon16x16' ], // icon path
                 $this->getElement(
                     $this->oFactory->oProp->aRootMenu,
                     'iPosition',
@@ -169,7 +169,7 @@ 
          */
         private function _registerSubMenuItem( array $aArgs ) {
 
-            if ( ! current_user_can( $aArgs[ 'capability' ] ) ) {
+            if ( !current_user_can( $aArgs[ 'capability' ] ) ) {
                 return '';
             }
                                     
@@ -235,16 +235,16 @@ 
              */
             private function _addPageSubmenuItem( $sRootPageSlug, $sMenuSlug, $sPageSlug, $sPageTitle, $sMenuTitle, $sCapability, $bShowInMenu, $nOrder ) {
                 
-                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".
@@ -269,14 +269,14 @@ 
                 $_aRemovedMenuItem = $this->_removePageSubmenuItem( $_nSubMenuPageIndex, $sMenuSlug, $sPageSlug, $sMenuTitle );
                 
                 // If the visibility option is `false`, remove the one just added from the sub-menu global array
-                if ( ! $bShowInMenu && ! $this->_isCurrentPage( $sPageSlug ) ) {
+                if ( !$bShowInMenu && !$this->_isCurrentPage( $sPageSlug ) ) {
                     return $_sPageHook;
                 }
                 
                 // Set the order index in the element of the `submenu` global array.
                 $this->_setSubMenuPageByIndex(
-                    $nOrder,                // user-set order
-                    $_aRemovedMenuItem,     // will be reassign with a new index
+                    $nOrder, // user-set order
+                    $_aRemovedMenuItem, // will be reassign with a new index
                     $sMenuSlug
                 );
 
@@ -316,7 +316,7 @@ 
                      */
                     add_action(
                         'current_screen',
-                        array( $this->oFactory, "load_pre_" . $sPageSlug ),
+                        array( $this->oFactory, "load_pre_".$sPageSlug ),
                         20
                     );
                     
@@ -325,15 +325,15 @@ 
                      * Set a low priority because the user may add in-page tabs in their callback method of this action hook.
                      * @since       3.6.3
                      */
-                    add_action( "load_" . $sPageSlug, array( $this->oFactory, '_replyToFinalizeInPageTabs' ), 9999 );
+                    add_action( "load_".$sPageSlug, array( $this->oFactory, '_replyToFinalizeInPageTabs' ), 9999 );
                     
                     // 3.6.3+
-                    add_action( "load_after_" . $sPageSlug, array( $this->oFactory, '_replyToEnqueuePageAssets' ) );
-                    add_action( "load_after_" . $sPageSlug, array( $this->oFactory, '_replyToEnablePageMetaBoxes' ) );  // 3.7.10+
+                    add_action( "load_after_".$sPageSlug, array( $this->oFactory, '_replyToEnqueuePageAssets' ) );
+                    add_action( "load_after_".$sPageSlug, array( $this->oFactory, '_replyToEnablePageMetaBoxes' ) ); // 3.7.10+
 
                     $this->oFactory->oProp->aPageHooks[ $sPageSlug ] = $this->getAOrB(
                         is_network_admin(),
-                        $sPageHook . '-network',
+                        $sPageHook.'-network',
                         $sPageHook
                     );
 
@@ -350,7 +350,7 @@ 
 
                     $_nNewIndex = $this->getUnusedNumericIndex(
                         $this->getElementAsArray( $GLOBALS, array( 'submenu', $sMenuSlug ) ), // subject array to parser
-                        $nOrder,    // a desired menu position
+                        $nOrder, // a desired menu position
                         5           // offset 
                     );
 
@@ -364,9 +364,9 @@ 
                  */
                 private function _getSubMenuPageIndex( $sMenuSlug, $sMenuTitle, $sPageTitle, $sPageSlug ) {
                     
-                    foreach( $this->getElementAsArray( $GLOBALS, array( 'submenu', $sMenuSlug ) ) as $_iIndex => $_aSubMenu ) {
+                    foreach ( $this->getElementAsArray( $GLOBALS, array( 'submenu', $sMenuSlug ) ) as $_iIndex => $_aSubMenu ) {
                       
-                        if ( ! isset( $_aSubMenu[ 3 ] ) ) {
+                        if ( !isset( $_aSubMenu[ 3 ] ) ) {
                             continue;
                         }
                                                
@@ -400,7 +400,7 @@ 
                  * @since       3.1.1       Moved from `AdminPageFramework_Menu`. Chagned the return type.
                  * @return      array       removed menu item.
                  */
-                private function _removePageSubmenuItem( $nSubMenuPageIndex, $sMenuSlug, $sPageSlug, $sMenuTitle ){
+                private function _removePageSubmenuItem( $nSubMenuPageIndex, $sMenuSlug, $sPageSlug, $sMenuTitle ) {
  
                     $_aRemovedMenuItem = $this->_removePageSubMenuItemByIndex(
                         $nSubMenuPageIndex,
@@ -474,7 +474,7 @@ 
              */
             private function _addLinkSubmenuItem( $sMenuSlug, $sTitle, $sCapability, $sHref, $bShowInMenu, $nOrder ) {
                 
-                if ( ! $bShowInMenu ) {
+                if ( !$bShowInMenu ) {
                     return;
                 }
     
@@ -489,9 +489,9 @@ 
                     5   // offset
                 );
                 $_aSubMenuItems[ $_nIndex ] = array(
-                    $sTitle,        // 0
-                    $sCapability,   // 1
-                    $sHref,         // 2   
+                    $sTitle, // 0
+                    $sCapability, // 1
+                    $sHref, // 2   
                 );
                 $GLOBALS[ 'submenu' ][ $sMenuSlug ] = $_aSubMenuItems;
                 

Braces +1 added lines, -1 removed lines

@@ -400,7 +400,7 @@
                  * @since       3.1.1       Moved from `AdminPageFramework_Menu`. Chagned the return type.
                  * @return      array       removed menu item.
                  */
-                private function _removePageSubmenuItem( $nSubMenuPageIndex, $sMenuSlug, $sPageSlug, $sMenuTitle ){
+                private function _removePageSubmenuItem( $nSubMenuPageIndex, $sMenuSlug, $sPageSlug, $sMenuTitle ) {
  
                     $_aRemovedMenuItem = $this->_removePageSubMenuItemByIndex(
                         $nSubMenuPageIndex,

development/factory/admin_page/AdminPageFramework_Controller.php

Doc Comments +5 added lines

@@ -224,6 +224,7 @@ 
     * @param        string      the tagged HTML link text.
     * @param        string      (optional) another tagged HTML link text.
     * @param        string      (optional) add more as many as want by adding items to the next parameters.
+    * @param string $sTaggedLinkHTML1
     * @access       public
     * @return       void
     */     
@@ -249,6 +250,9 @@ 
     * @param        string      the tagged HTML link text.
     * @param        string      (optional) another tagged HTML link text.
     * @param        string      (optional) add more as many as want by adding items to the next parameters.
+    * @param null|string $sTaggedLinkHTML1
+    * @param string $sTaggedLinkHTML2
+    * @param string $_and_more
     * @access       public
     * @return       void
     */    
@@ -268,6 +272,7 @@ 
      * 
      * @since       3.1.0
      * @since       3.3.1       Moved from `AdminPageFramework`.
+     * @param string $sLabel
      */  
     public function setPluginSettingsLinkLabel( $sLabel ) {
         $this->oProp->sLabelPluginSettingsLink = $sLabel;

Indentation +35 added lines, -35 removed lines

@@ -219,24 +219,24 @@ 
     }
     
     /**
-    * Adds the given link(s) into the description cell of the plugin listing table.
-    * 
-    * <h4>Example</h4>
-    * <code>$this->addLinkToPluginDescription( 
-    *       "<a href='http://www.google.com'>Google</a>",
-    *       "<a href='http://www.yahoo.com'>Yahoo!</a>"
-    * );</code>
-    * 
-    * @since        2.0.0
-    * @since        3.0.0       Changed the scope to public from protected.
-    * @since        3.3.1       Moved from `AdminPageFramework`.
-    * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-    * @param        string      the tagged HTML link text.
-    * @param        string      (optional) another tagged HTML link text.
-    * @param        string      (optional) add more as many as want by adding items to the next parameters.
-    * @access       public
-    * @return       void
-    */
+     * Adds the given link(s) into the description cell of the plugin listing table.
+     * 
+     * <h4>Example</h4>
+     * <code>$this->addLinkToPluginDescription( 
+     *       "<a href='http://www.google.com'>Google</a>",
+     *       "<a href='http://www.yahoo.com'>Yahoo!</a>"
+     * );</code>
+     * 
+     * @since        2.0.0
+     * @since        3.0.0       Changed the scope to public from protected.
+     * @since        3.3.1       Moved from `AdminPageFramework`.
+     * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
+     * @param        string      the tagged HTML link text.
+     * @param        string      (optional) another tagged HTML link text.
+     * @param        string      (optional) add more as many as want by adding items to the next parameters.
+     * @access       public
+     * @return       void
+     */
     public function addLinkToPluginDescription( $sTaggedLinkHTML1, $sTaggedLinkHTML2=null, $_and_more=null ) {
         if ( 'plugins.php' !== $this->oProp->sPageNow ) {
             return;
@@ -245,23 +245,23 @@ 
     }
 
     /**
-    * Adds the given link(s) into the title cell of the plugin listing table.
-    * 
-    * <h4>Example</h4>
-    * <code>$this->addLinkToPluginTitle( 
-    *       "<a href='http://www.wordpress.org'>WordPress</a>"
-    * );</code>
-    * 
-    * @since        2.0.0
-    * @since        3.0.0       Changed the scope to public from protected.
-    * @since        3.3.1       Moved from `AdminPageFramework`.
-    * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-    * @param        string      the tagged HTML link text.
-    * @param        string      (optional) another tagged HTML link text.
-    * @param        string      (optional) add more as many as want by adding items to the next parameters.
-    * @access       public
-    * @return       void
-    */
+     * Adds the given link(s) into the title cell of the plugin listing table.
+     * 
+     * <h4>Example</h4>
+     * <code>$this->addLinkToPluginTitle( 
+     *       "<a href='http://www.wordpress.org'>WordPress</a>"
+     * );</code>
+     * 
+     * @since        2.0.0
+     * @since        3.0.0       Changed the scope to public from protected.
+     * @since        3.3.1       Moved from `AdminPageFramework`.
+     * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
+     * @param        string      the tagged HTML link text.
+     * @param        string      (optional) another tagged HTML link text.
+     * @param        string      (optional) add more as many as want by adding items to the next parameters.
+     * @access       public
+     * @return       void
+     */
     public function addLinkToPluginTitle( $sTaggedLinkHTML1, $sTaggedLinkHTML2=null, $_and_more=null ) {
     
         if ( 'plugins.php' !== $this->oProp->sPageNow ) {

Spacing +10 added lines, -10 removed lines

@@ -115,7 +115,7 @@ 
      * @param       array       $aCustomArgs    (optional) The argument array for more advanced parameters.
      * @return      array       The array holing the queued items.
      */
-    public function enqueueStyles( $aSRCs, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {
+    public function enqueueStyles( $aSRCs, $sPageSlug = '', $sTabSlug = '', $aCustomArgs = array() ) {
         return $this->oResource->_enqueueStyles( $aSRCs, $sPageSlug, $sTabSlug, $aCustomArgs );
     }
     /**
@@ -150,7 +150,7 @@ 
      * </ul>
      * @return      string      The style handle ID. If the passed url is not a valid url string, an empty string will be returned.
      */
-    public function enqueueStyle( $sSRC, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {
+    public function enqueueStyle( $sSRC, $sPageSlug = '', $sTabSlug = '', $aCustomArgs = array() ) {
         return $this->oResource->_enqueueStyle( $sSRC, $sPageSlug, $sTabSlug, $aCustomArgs );
     }
     /**
@@ -175,7 +175,7 @@ 
      * @param       array       (optional) The argument array for more advanced parameters.
      * @return      array        The array holding the queued items.
      */
-    public function enqueueScripts( $aSRCs, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {
+    public function enqueueScripts( $aSRCs, $sPageSlug = '', $sTabSlug = '', $aCustomArgs = array() ) {
         return $this->oResource->_enqueueScripts( $aSRCs, $sPageSlug, $sTabSlug, $aCustomArgs );
     }
     /**
@@ -214,7 +214,7 @@ 
      * </ul>
      * @return      string      The script handle ID. If the passed url is not a valid url string, an empty string will be returned.
      */
-    public function enqueueScript( $sSRC, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {
+    public function enqueueScript( $sSRC, $sPageSlug = '', $sTabSlug = '', $aCustomArgs = array() ) {
         return $this->oResource->_enqueueScript( $sSRC, $sPageSlug, $sTabSlug, $aCustomArgs );
     }
     
@@ -237,7 +237,7 @@ 
     * @access       public
     * @return       void
     */
-    public function addLinkToPluginDescription( $sTaggedLinkHTML1, $sTaggedLinkHTML2=null, $_and_more=null ) {
+    public function addLinkToPluginDescription( $sTaggedLinkHTML1, $sTaggedLinkHTML2 = null, $_and_more = null ) {
         if ( 'plugins.php' !== $this->oProp->sPageNow ) {
             return;
         }
@@ -262,7 +262,7 @@ 
     * @access       public
     * @return       void
     */
-    public function addLinkToPluginTitle( $sTaggedLinkHTML1, $sTaggedLinkHTML2=null, $_and_more=null ) {
+    public function addLinkToPluginTitle( $sTaggedLinkHTML1, $sTaggedLinkHTML2 = null, $_and_more = null ) {
     
         if ( 'plugins.php' !== $this->oProp->sPageNow ) {
             return;
@@ -321,7 +321,7 @@ 
      * @param       string      (optional) The class selector used in the message HTML element. 'error' and 'updated' are prepared by WordPress but it's not limited to them and can pass a custom name. Default: 'error'.
      * @param       string      (optional) The ID of the message. If not set, the hash of the message will be used.
      */
-    public function setAdminNotice( $sMessage, $sClassSelector='error', $sID='' ) {
+    public function setAdminNotice( $sMessage, $sClassSelector = 'error', $sID = '' ) {
             
         $sID = $sID ? $sID : md5( $sMessage );
         
@@ -358,9 +358,9 @@ 
      * @param       boolean         If true, the passed key(s) will be appended to the property; otherwise, it will override the property.
      * @return      void
      */
-    public function setDisallowedQueryKeys( $asQueryKeys, $bAppend=true ) {
+    public function setDisallowedQueryKeys( $asQueryKeys, $bAppend = true ) {
         
-        if ( ! $bAppend ) {
+        if ( !$bAppend ) {
             $this->oProp->aDisallowedQueryKeys = ( array ) $asQueryKeys;
 
             return;
@@ -404,7 +404,7 @@ 
      * @param       mixed       $vDefault       the default value that will be returned if nothing is stored.
      * @return      mixed       If the field ID is not specified
      */
-    static public function getOption( $sOptionKey, $asKey=null, $vDefault=null ) {
+    static public function getOption( $sOptionKey, $asKey = null, $vDefault = null ) {
         return AdminPageFramework_WPUtility::getOption( $sOptionKey, $asKey, $vDefault );
     }
     

development/factory/post_type/_model/AdminPageFramework_PostType_Model__FlushRewriteRules.php

Doc Comments +1 added lines

@@ -26,6 +26,7 @@
      * Sets up hooks and properties.
      * 
      * @internal
+     * @param AdminPageFramework_PostType_Model $oFactory
      */
     public function __construct( $oFactory ) {
                 

Indentation +1 added lines, -1 removed lines

@@ -277,7 +277,7 @@
         );        
     }    
     
-       /**
+        /**
          * Extracts meta box form fields options array from the given options array of an admin page.
          * 
          * @since       3.5.6

Spacing +4 added lines, -4 removed lines

@@ -29,7 +29,7 @@ 
      */
     public function __construct( $oFactory ) {
                 
-        if ( ! $this->_shouldProceed( $oFactory ) ) {
+        if ( !$this->_shouldProceed( $oFactory ) ) {
             return;
         }        
         
@@ -54,10 +54,10 @@ 
          */
         private function _shouldProceed( $oFactory ) {
 
-            if ( ! $oFactory->oProp->bIsAdmin ) {
+            if ( !$oFactory->oProp->bIsAdmin ) {
                 return false;
             }        
-            if ( ! $oFactory->oProp->sCallerPath ) {
+            if ( !$oFactory->oProp->sCallerPath ) {
                 return false;
             }
             return 'plugin' === $oFactory->oProp->sScriptType;
@@ -87,7 +87,7 @@ 
         }
                 
         // If the execution flow in the plugin activation hook, schedule flushing rewrite rules.
-        if ( did_action( 'activate_' . plugin_basename( $this->oFactory->oProp->sCallerPath ) ) ) {
+        if ( did_action( 'activate_'.plugin_basename( $this->oFactory->oProp->sCallerPath ) ) ) {
             add_action( 'shutdown', array( $this, '_replyToFlushRewriteRules' ) );
         }
 

development/factory/post_type/_model/AdminPageFramework_PostType_Model__SubMenuOrder.php

Doc Comments +3 added lines

@@ -26,6 +26,7 @@ 
      * Sets up hooks and properties.
      * 
      * @internal
+     * @param AdminPageFramework_PostType_Model $oFactory
      */
     public function __construct( $oFactory ) {
           
@@ -82,6 +83,7 @@ 
     
         /**
          * @since       3.7.4
+         * @param string $sSubMenuSlug
          */
         private function _setSubMenuSlugForSorting( $sSubMenuSlug ) {
                 
@@ -94,6 +96,7 @@ 
         
         /**
          * @since       3.7.4
+         * @param string $sSubMenuSlug
          */
         private function _setSubMenuItemIndex( $sSubMenuSlug ) {                
                                         

Spacing +12 added lines, -12 removed lines

@@ -31,7 +31,7 @@ 
           
         $this->oFactory = $oFactory;
           
-        if ( ! $oFactory->oProp->bIsAdmin ) {
+        if ( !$oFactory->oProp->bIsAdmin ) {
             return;
         }
         
@@ -47,7 +47,7 @@ 
         
         add_action(
             'admin_menu',
-            array( $this, 'sortAdminSubMenu' ),  // defined in the framework utility class.
+            array( $this, 'sortAdminSubMenu' ), // defined in the framework utility class.
             9999
         );
             
@@ -62,15 +62,15 @@ 
             
         // Check the post type `show_ui` and other related UI arguments.
         $_bsShowInMeenu = $this->getShowInMenuPostTypeArgument( $this->oFactory->oProp->aPostTypeArgs );
-        if ( ! $_bsShowInMeenu ) {
+        if ( !$_bsShowInMeenu ) {
             return;
         }
         
         // If the user sets a menu slug to the 'show_in_menu' argument, use that. 
         // It is used to set a custom post type sub-menu belong to another menu.
-        $_sSubMenuSlug  = is_string( $_bsShowInMeenu )
+        $_sSubMenuSlug = is_string( $_bsShowInMeenu )
             ? $_bsShowInMeenu
-            : 'edit.php?post_type=' . $this->oFactory->oProp->sPostType;
+            : 'edit.php?post_type='.$this->oFactory->oProp->sPostType;
         
         // Set the index to the framework specific global array for sorting.
         $this->_setSubMenuSlugForSorting( $_sSubMenuSlug );
@@ -131,11 +131,11 @@ 
 
                 // @remark      This is the partial link url set in the third element ( index of 2 ) in the third dimension of submenu global array element.
                 // This is not the submenu slug.
-                $_sLinkSlugManage = 'edit.php?post_type=' . $this->oFactory->oProp->sPostType;
+                $_sLinkSlugManage = 'edit.php?post_type='.$this->oFactory->oProp->sPostType;
                                 
                 $_aLinkSlugs = array(
                     $_sLinkSlugManage => $_nSubMenuOrderManage,
-                    'post-new.php?post_type=' . $this->oFactory->oProp->sPostType => $_nSubMenuOrderAddNew,
+                    'post-new.php?post_type='.$this->oFactory->oProp->sPostType => $_nSubMenuOrderAddNew,
                 );
 
                 // If the user does not set a custom value, unset it
@@ -144,8 +144,8 @@ 
                 }
                 
                 // If the user does not want to show the Add New sub menu, no need to change the order.
-                if ( ! $_bShowAddNew || 10 == $_nSubMenuOrderAddNew ) {
-                    unset( $_aLinkSlugs[ 'post-new.php?post_type=' . $this->oFactory->oProp->sPostType ] );
+                if ( !$_bShowAddNew || 10 == $_nSubMenuOrderAddNew ) {
+                    unset( $_aLinkSlugs[ 'post-new.php?post_type='.$this->oFactory->oProp->sPostType ] );
                 }
                 
                 return $_aLinkSlugs;
@@ -165,9 +165,9 @@ 
          */
         private function _setSubMenuIndexByLinksSlugs( $sSubMenuSlug, array $aLinkSlugs ) {
 
-            foreach( $this->getElementAsArray( $GLOBALS, array( 'submenu', $sSubMenuSlug ) ) as $_nIndex => $_aSubMenuItem ) {
+            foreach ( $this->getElementAsArray( $GLOBALS, array( 'submenu', $sSubMenuSlug ) ) as $_nIndex => $_aSubMenuItem ) {
                 
-                foreach( $aLinkSlugs as $_sLinkSlug => $_nOrder ) {
+                foreach ( $aLinkSlugs as $_sLinkSlug => $_nOrder ) {
                     
                     $_bIsSet = $this->_setSubMenuIndexByLinksSlug( $sSubMenuSlug, $_nIndex, $_aSubMenuItem, $_sLinkSlug, $_nOrder );
                     
@@ -193,7 +193,7 @@ 
             private function _setSubMenuIndexByLinksSlug( $sSubMenuSlug, $nIndex, $aSubMenuItem, $sLinkSlug, $nOrder ) {
                 
                 // The third item is the link slug.
-                if ( ! isset( $aSubMenuItem[ 2 ] ) ) {
+                if ( !isset( $aSubMenuItem[ 2 ] ) ) {
                     return false;
                 }
                 if ( $aSubMenuItem[ 2 ] !== $sLinkSlug ) {