michaeluno / admin-page-framework

development/factory/_common/utility/AdminPageFramework_Debug.php

Doc Comments +5 added lines, -1 removed lines

@@ -177,6 +177,7 @@ 
          * Determines the log file path.
          * @since       3.5.3 
          * @internal    
+         * @param string|null $bsFilePath
          * @return      string      The path of the file to log the contents.
          */
         static private function _getLogFilePath( $bsFilePath, $sCallerClass ) {
@@ -213,6 +214,8 @@ 
          * Returns the heading part of a log item.
          * @since       3.5.3
          * @internal
+         * @param double $fCurrentTimeStamp
+         * @param double $nElapsed
          * @return      string      the heading part of a log item.
          */
         static private function _getLogHeadingLine( $fCurrentTimeStamp, $nElapsed, $sCallerClass, $sCallerFunction ) {
@@ -411,7 +414,6 @@ 
                 /**
                  * @return      string
                  * @param       scalar      $sScalar        
-                 * @param       integer     $iCharLimit     Character length limit to truncate.
                  * @since       3.8.9
                  */
                 static private function _getLegibleScalar( $sScalar ) {
@@ -441,6 +443,7 @@ 
                         
                     }                
                     /**
+                     * @param string $sString
                      * @return      string
                      */
                     static private function _getLegibleString( $sString, $iCharLimit=200 ) {
@@ -485,6 +488,7 @@ 
     
         /**
          * Performs `array_map()` recursively.
+         * @param string[] $oCallable
          * @return      array.
          * @since       3.8.9
          */

Spacing +45 added lines, -45 removed lines

@@ -33,7 +33,7 @@ 
      * @param       string          $sFilePath      The file path for a log file.
      * @return      void
      */
-    static public function dump( $asArray, $sFilePath=null ) {
+    static public function dump( $asArray, $sFilePath = null ) {
         echo self::get( $asArray, $sFilePath );
     }    
         /**
@@ -44,7 +44,7 @@ 
          * @since unknown
          * @deprecated      3.2.0
          */
-        static public function dumpArray( $asArray, $sFilePath=null ) {
+        static public function dumpArray( $asArray, $sFilePath = null ) {
             self::dump( $asArray, $sFilePath );
         }    
     
@@ -53,7 +53,7 @@ 
      * @since       3.8.9
      * @return      string
      */
-    static public function getDetails( $mValue, $bEscape=true ) {    
+    static public function getDetails( $mValue, $bEscape = true ) {    
         $_sValueWithDetails = self::_getArrayRepresentationSanitized(
             self::_getLegible( $mValue )
         );
@@ -96,7 +96,7 @@ 
      * @param       string          $sFilePath      The file path for a log file.
      * @param       boolean         $bEscape        Whether to escape characters.
      */
-    static public function get( $asArray, $sFilePath=null, $bEscape=true ) {
+    static public function get( $asArray, $sFilePath = null, $bEscape = true ) {
 
         if ( $sFilePath ) {
             self::log( $asArray, $sFilePath );     
@@ -118,8 +118,8 @@ 
          * @since       3.0.0 Changed the $bEncloseInTag parameter to bEscape.
          * @deprecated  3.2.0
          */
-        static public function getArray( $asArray, $sFilePath=null, $bEscape=true ) {
-            self::showDeprecationNotice( __CLASS__ .'::' . __FUNCTION__,  __CLASS__ .'::get()' );
+        static public function getArray( $asArray, $sFilePath = null, $bEscape = true ) {
+            self::showDeprecationNotice( __CLASS__.'::'.__FUNCTION__, __CLASS__.'::get()' );
             return self::get( $asArray, $sFilePath, $bEscape );
         }      
             
@@ -141,18 +141,18 @@ 
      * @param       string      $sFilePath      The log file path.
      * @return      void
      **/
-    static public function log( $mValue, $sFilePath=null ) {
+    static public function log( $mValue, $sFilePath = null ) {
                 
         static $_fPreviousTimeStamp = 0;
         
         $_oCallerInfo       = debug_backtrace();
         $_sCallerFunction   = self::getElement(
-            $_oCallerInfo,  // subject array
+            $_oCallerInfo, // subject array
             array( 1, 'function' ), // key
             ''      // default
         );                        
-        $_sCallerClass      = self::getElement(
-            $_oCallerInfo,  // subject array
+        $_sCallerClass = self::getElement(
+            $_oCallerInfo, // subject array
             array( 1, 'class' ), // key
             ''      // default
         );           
@@ -162,11 +162,11 @@ 
             self::_getLogFilePath( $sFilePath, $_sCallerClass ), 
             self::_getLogHeadingLine( 
                 $_fCurrentTimeStamp,
-                round( $_fCurrentTimeStamp - $_fPreviousTimeStamp, 3 ),     // elapsed time
+                round( $_fCurrentTimeStamp - $_fPreviousTimeStamp, 3 ), // elapsed time
                 $_sCallerClass,
                 $_sCallerFunction
-            ) . PHP_EOL
-            . self::_getLegible( $mValue ) . PHP_EOL . PHP_EOL,
+            ).PHP_EOL
+            . self::_getLegible( $mValue ).PHP_EOL.PHP_EOL,
             FILE_APPEND 
         );     
         
@@ -187,9 +187,9 @@ 
             }
             // Return a generated default log path.
             if ( true === $bsFilePath ) {
-                return WP_CONTENT_DIR . DIRECTORY_SEPARATOR . basename( get_class() ) . '_' . date( "Ymd" ) . '.log';
+                return WP_CONTENT_DIR.DIRECTORY_SEPARATOR.basename( get_class() ).'_'.date( "Ymd" ).'.log';
             }
-            return WP_CONTENT_DIR . DIRECTORY_SEPARATOR . basename( get_class() ) . '_' . basename( $sCallerClass ) . '_' . date( "Ymd" ) . '.log';
+            return WP_CONTENT_DIR.DIRECTORY_SEPARATOR.basename( get_class() ).'_'.basename( $sCallerClass ).'_'.date( "Ymd" ).'.log';
             
         }
             /**
@@ -198,7 +198,7 @@ 
              * @internal
              */
             static private function _createFile( $sFilePath ) {
-                if ( ! $sFilePath || true === $sFilePath ) {
+                if ( !$sFilePath || true === $sFilePath ) {
                     return false;
                 }
                 if ( file_exists( $sFilePath ) ) {
@@ -230,11 +230,11 @@ 
             $_nMicroseconds     = str_pad( round( ( $_nNow - floor( $_nNow ) ) * 10000 ), 4, '0' );
             
             $_aOutput           = array(
-                date( "Y/m/d H:i:s", $_nNow ) . '.' . $_nMicroseconds,
+                date( "Y/m/d H:i:s", $_nNow ).'.'.$_nMicroseconds,
                 self::_getFormattedElapsedTime( $nElapsed ),
                 $_iPageLoadID,
                 AdminPageFramework_Registry::getVersion(),
-                $sCallerClass . '::' . $sCallerFunction,
+                $sCallerClass.'::'.$sCallerFunction,
                 current_filter(),
                 self::getCurrentURL(),
             );
@@ -252,22 +252,22 @@ 
                 $_aElapsedParts     = explode( ".", ( string ) $nElapsed );
                 $_sElapsedFloat     = str_pad(
                     self::getElement(
-                        $_aElapsedParts,  // subject array
+                        $_aElapsedParts, // subject array
                         1, // key
                         0      // default
                     ),      
                     3, 
                     '0'
                 );
-                $_sElapsed          = self::getElement(
-                    $_aElapsedParts,  // subject array
-                    0,  // key
+                $_sElapsed = self::getElement(
+                    $_aElapsedParts, // subject array
+                    0, // key
                     0   // default
                 );                                   
-                $_sElapsed          = strlen( $_sElapsed ) > 1 
-                    ? '+' . substr( $_sElapsed, -1, 2 ) 
-                    : ' ' . $_sElapsed;
-                return $_sElapsed . '.' . $_sElapsedFloat;
+                $_sElapsed = strlen( $_sElapsed ) > 1 
+                    ? '+'.substr( $_sElapsed, -1, 2 ) 
+                    : ' '.$_sElapsed;
+                return $_sElapsed.'.'.$_sElapsedFloat;
             
             }
         /**
@@ -277,8 +277,8 @@ 
          * @since       3.0.3   Changed the default log location and file name.
          * @deprecated  3.1.0   Use the `log()` method instead.
          */
-        static public function logArray( $asArray, $sFilePath=null ) {
-            self::showDeprecationNotice( __CLASS__ .'::' . __FUNCTION__,  __CLASS__ .'::log()' );
+        static public function logArray( $asArray, $sFilePath = null ) {
+            self::showDeprecationNotice( __CLASS__.'::'.__FUNCTION__, __CLASS__.'::log()' );
             self::log( $asArray, $sFilePath );     
         }      
         
@@ -313,7 +313,7 @@ 
          */
         static private function _getObjectName( $mItem ) {
             if ( is_object( $mItem ) ) {
-                return '(object) ' . get_class( $mItem );
+                return '(object) '.get_class( $mItem );
             }
             return $mItem;
         }
@@ -325,8 +325,8 @@ 
          */
         static private function _getLegible( $mValue ) {                
             if ( is_array( $mValue ) ) {            
-                return '(array, length: ' . count( $mValue ).') ' 
-                    . print_r( self::_getLegibleArray( $mValue ) , true );
+                return '(array, length: '.count( $mValue ).') ' 
+                    . print_r( self::_getLegibleArray( $mValue ), true );
             }
             return print_r( self::_getLegibleValue( $mValue ), true );
         }
@@ -339,16 +339,16 @@ 
         static private function _getLegibleCallable( $asoCallable ) {
             
             if ( is_string( $asoCallable ) ) {
-                return '(callable) ' . $asoCallable;
+                return '(callable) '.$asoCallable;
             }
             if ( is_object( $asoCallable ) ) {
-                return '(callable) ' . get_class( $asoCallable );
+                return '(callable) '.get_class( $asoCallable );
             }
             $_sSubject = is_object( $asoCallable[ 0 ] )
                 ? get_class( $asoCallable[ 0 ] )
                 : ( string ) $asoCallable[ 0 ];
 
-            return '(callable) ' . $_sSubject . '::' . ( string ) $asoCallable[ 1 ];
+            return '(callable) '.$_sSubject.'::'.( string ) $asoCallable[ 1 ];
             
         }        
         /**
@@ -361,8 +361,8 @@ 
             if ( method_exists( $oObject, '__toString' ) ) {
                 return ( string ) $oObject;
             }
-            return '(object) ' . get_class( $oObject ) . ' ' 
-                . count( get_object_vars( $oObject ) ) . ' properties.';
+            return '(object) '.get_class( $oObject ).' ' 
+                . count( get_object_vars( $oObject ) ).' properties.';
             
         } 
         /**
@@ -400,12 +400,12 @@ 
                         return '(null)';
                     }                    
                     if ( is_object( $mNonScalar ) ) {
-                        return '(' . $_sType . ') ' . get_class( $mNonScalar );
+                        return '('.$_sType.') '.get_class( $mNonScalar );
                     }
                     if ( is_array( $mNonScalar ) ) {
-                        return '(' . $_sType . ') ' . count( $mNonScalar ) . ' elements';
+                        return '('.$_sType.') '.count( $mNonScalar ).' elements';
                     }
-                    return '(' . $_sType . ') ' . ( string ) $mNonScalar;
+                    return '('.$_sType.') '.( string ) $mNonScalar;
                     
                 }
                 /**
@@ -417,11 +417,11 @@ 
                 static private function _getLegibleScalar( $sScalar ) {
                  
                     if ( is_bool( $sScalar ) ) {
-                        return '(boolean) ' . ( $sScalar ? 'true' : 'false' );
+                        return '(boolean) '.( $sScalar ? 'true' : 'false' );
                     }                 
                     return is_string( $sScalar )
                         ? self::_getLegibleString( $sScalar )
-                        : '(' . gettype( $sScalar ) . ', length: ' . self::_getValueLength( $sScalar ) .  ') ' . $sScalar;
+                        : '('.gettype( $sScalar ).', length: '.self::_getValueLength( $sScalar ).') '.$sScalar;
                 }
                     /**
                      * Returns a length of a value.
@@ -443,7 +443,7 @@ 
                     /**
                      * @return      string
                      */
-                    static private function _getLegibleString( $sString, $iCharLimit=200 ) {
+                    static private function _getLegibleString( $sString, $iCharLimit = 200 ) {
                     
                         static $_iMBSupport;
                         $_iMBSupport    = isset( $_iMBSupport ) ? $_iMBSupport : ( integer ) function_exists( 'mb_strlen' );
@@ -452,8 +452,8 @@ 
                         
                         $_iCharLength   = call_user_func_array( $_aStrLenMethod[ $_iMBSupport ], array( $sString ) );
                         return $_iCharLength <= $iCharLimit
-                            ? '(string, length: ' . $_iCharLength . ') ' . $sString
-                            : '(string, length: ' . $_iCharLength . ') ' . call_user_func_array( $_aSubstrMethod[ $_iMBSupport ], array( $sString, 0, $iCharLimit ) )
+                            ? '(string, length: '.$_iCharLength.') '.$sString
+                            : '(string, length: '.$_iCharLength.') '.call_user_func_array( $_aSubstrMethod[ $_iMBSupport ], array( $sString, 0, $iCharLimit ) )
                                 . '...';
                         
                     }
@@ -466,7 +466,7 @@ 
          * @return      array
          * @internal
          */
-        static private function _getSliceByDepth( array $aSubject, $iDepth=0 ) {
+        static private function _getSliceByDepth( array $aSubject, $iDepth = 0 ) {
 
             foreach ( $aSubject as $_sKey => $_vValue ) {
                 if ( is_array( $_vValue ) ) {

Braces +4 added lines, -4 removed lines

@@ -53,7 +53,7 @@ 
      * @since       3.8.9
      * @return      string
      */
-    static public function getDetails( $mValue, $bEscape=true ) {    
+    static public function getDetails( $mValue, $bEscape=true ) {
         $_sValueWithDetails = self::_getArrayRepresentationSanitized(
             self::_getLegible( $mValue )
         );
@@ -323,8 +323,8 @@ 
          * @since       3.8.9
          * @return      string
          */
-        static private function _getLegible( $mValue ) {                
-            if ( is_array( $mValue ) ) {            
+        static private function _getLegible( $mValue ) {
+            if ( is_array( $mValue ) ) {
                 return '(array, length: ' . count( $mValue ).') ' 
                     . print_r( self::_getLegibleArray( $mValue ) , true );
             }
@@ -502,7 +502,7 @@ 
              * @return      mixed       A modified value.
              * @since       3.8.9
              */
-            static private function _getArrayMappedNested( $mItem ) {            
+            static private function _getArrayMappedNested( $mItem ) {
                 return is_array( $mItem ) 
                     ? array_map( array( __CLASS__, '_getArrayMappedNested' ), $mItem ) 
                     : call_user_func( self::$_oCurrentCallableForArrayMapRecursive, $mItem );            

admin-page-framework-loader.php

Spacing +22 added lines, -22 removed lines

@@ -16,9 +16,9 @@ 
  */
 class AdminPageFrameworkLoader_Registry_Base {
 
-    const VERSION        = '3.8.9b02';    // <--- DON'T FORGET TO CHANGE THIS AS WELL!!
+    const VERSION        = '3.8.9b02'; // <--- DON'T FORGET TO CHANGE THIS AS WELL!!
     const NAME           = 'Admin Page Framework - Loader'; // the name is not 'Admin Page Framework' because warning messages gets confusing.
-    const SHORTNAME      = 'Admin Page Framework';  // used for a menu title etc.
+    const SHORTNAME      = 'Admin Page Framework'; // used for a menu title etc.
     const DESCRIPTION    = 'Loads Admin Page Framework which facilitates WordPress plugin and theme development.';
     const URI            = 'http://admin-page-framework.michaeluno.jp/';
     const AUTHOR         = 'miunosoft (Michael Uno)';
@@ -55,14 +55,14 @@ 
      * @remark      This is also accessed from `uninstall.php` so do not remove.
      * @remark      Do not exceed 8 characters as a transient name allows 45 characters or less ( 40 for site transients ) so that md5 (32 characters) can be added.
      */
-    const TRANSIENT_PREFIX         = 'APFL_';
+    const TRANSIENT_PREFIX = 'APFL_';
 
     /**
      * The hook slug used for the prefix of action and filter hook names.
      * 
      * @remark      The ending underscore is not necessary.
      */
-    const HOOK_SLUG                = 'admin_page_framework_loader';
+    const HOOK_SLUG = 'admin_page_framework_loader';
 
     /**
      * The text domain slug and its path.
@@ -116,7 +116,7 @@ 
      */
     static public $aAdminPages = array(
         // key => 'page slug'
-        'about'     => 'apfl_about',        // the welcome page
+        'about'     => 'apfl_about', // the welcome page
         'addon'     => 'apfl_addons',
         'tool'      => 'apfl_tools',
         'help'      => 'apfl_contact',
@@ -154,12 +154,12 @@ 
      * @since       3.5.0
      * @return      string
      */
-    public static function getPluginURL( $sRelativePath='' ) {
+    public static function getPluginURL( $sRelativePath = '' ) {
         if ( isset( self::$_sPluginURLCache ) ) {
-            return self::$_sPluginURLCache . $sRelativePath;
+            return self::$_sPluginURLCache.$sRelativePath;
         }
         self::$_sPluginURLCache = trailingslashit( plugins_url( '', self::$sFilePath ) );
-        return self::$_sPluginURLCache . $sRelativePath;
+        return self::$_sPluginURLCache.$sRelativePath;
     }
         /**
          * @since       3.7.9
@@ -189,13 +189,13 @@ 
      * @since       3.5.0
      * @return      void
      */ 
-    static public function setAdminNotice( $sMessage, $sClassAttribute='error' ) {
-        if ( ! is_admin() ) {  
+    static public function setAdminNotice( $sMessage, $sClassAttribute = 'error' ) {
+        if ( !is_admin() ) {  
             return; 
         }
-        self::$_aAdminNotices[] = array(
+        self::$_aAdminNotices[ ] = array(
             'message'           => $sMessage,
-            'class_attribute'   => trim( $sClassAttribute ) . ' notice is-dismissible',
+            'class_attribute'   => trim( $sClassAttribute ).' notice is-dismissible',
         );
         add_action( 'admin_notices', array( __CLASS__, '_replyToSetAdminNotice' ) );
     }
@@ -205,12 +205,12 @@ 
          * @return      void
          */
         static public function _replyToSetAdminNotice() {
-            foreach( self::$_aAdminNotices as $_aAdminNotice ) {
-                echo "<div class='" . esc_attr( $_aAdminNotice['class_attribute'] ) . " notice is-dismissible'>"
+            foreach ( self::$_aAdminNotices as $_aAdminNotice ) {
+                echo "<div class='".esc_attr( $_aAdminNotice[ 'class_attribute' ] )." notice is-dismissible'>"
                         ."<p>"
                             . sprintf(
-                                '<strong>%1$s</strong>: ' . $_aAdminNotice['message'],
-                                self::NAME . ' ' . self::VERSION
+                                '<strong>%1$s</strong>: '.$_aAdminNotice[ 'message' ],
+                                self::NAME.' '.self::VERSION
                             )
                         . "</p>"
                     . "</div>";
@@ -222,7 +222,7 @@ 
 AdminPageFrameworkLoader_Registry::setUp( __FILE__ );
 
 // Initial checks. - Do no load if accessed directly, not exiting because the 'uninstall.php' and inclusion list generator will load this file.
-if ( ! defined( 'ABSPATH' ) ) {
+if ( !defined( 'ABSPATH' ) ) {
     return;
 }
 if ( defined( 'DOING_UNINSTALL' ) ) {
@@ -234,8 +234,8 @@ 
 
     $_bFrameworkLoaded = class_exists( 'AdminPageFramework_Registry', false );
     if (
-        ! $_bFrameworkLoaded
-        || ! defined( 'AdminPageFramework_Registry::VERSION' ) // backward compatibility
+        !$_bFrameworkLoaded
+        || !defined( 'AdminPageFramework_Registry::VERSION' ) // backward compatibility
         || version_compare( AdminPageFramework_Registry::VERSION, AdminPageFrameworkLoader_Registry::VERSION, '<' )
     ) {
         AdminPageFrameworkLoader_Registry::setAdminNotice(
@@ -253,18 +253,18 @@ 
 add_action( 'admin_init', 'AdminPageFrameworkLoader_Warning' );
 
 // Include the library file - the development version will be available if you cloned the GitHub repository.
-$_sDevelopmentVersionPath = AdminPageFrameworkLoader_Registry::$sDirPath . '/development/admin-page-framework.php';
+$_sDevelopmentVersionPath = AdminPageFrameworkLoader_Registry::$sDirPath.'/development/admin-page-framework.php';
 $_bDebugMode              = defined( 'WP_DEBUG' ) && WP_DEBUG;
 $_bLoadDevelopmentVersion = $_bDebugMode && file_exists( $_sDevelopmentVersionPath );
 include(
     $_bLoadDevelopmentVersion
         ? $_sDevelopmentVersionPath
-        : AdminPageFrameworkLoader_Registry::$sDirPath . '/library/apf/admin-page-framework.php'
+        : AdminPageFrameworkLoader_Registry::$sDirPath.'/library/apf/admin-page-framework.php'
 );
 
 // Include the framework loader plugin components.
 include( AdminPageFramework_Registry::$aClassFiles[ 'AdminPageFramework_PluginBootstrap' ] );
-include( AdminPageFrameworkLoader_Registry::$sDirPath . '/include/class/AdminPageFrameworkLoader_Bootstrap.php' );
+include( AdminPageFrameworkLoader_Registry::$sDirPath.'/include/class/AdminPageFrameworkLoader_Bootstrap.php' );
 new AdminPageFrameworkLoader_Bootstrap(
     AdminPageFrameworkLoader_Registry::$sFilePath,
     AdminPageFrameworkLoader_Registry::HOOK_SLUG    // hook prefix