michaeluno / admin-page-framework

development/factory/admin_page/AdminPageFramework.php

Doc Comments +2 added lines, -1 removed lines

@@ -46,7 +46,7 @@ 
      * @since       2.0.0
      * @see         http://codex.wordpress.org/Roles_and_Capabilities
      * @see         http://codex.wordpress.org/I18n_for_WordPress_Developers#Text_Domains
-     * @param       array|integer|string    $aisOptionKey    (optional) specifies the option key name to store in the options table. If this is not set, the instantiated class name will be used as default. 
+     * @param       array|integer|string    $isOptionKey    (optional) specifies the option key name to store in the options table. If this is not set, the instantiated class name will be used as default. 
      * [3.5.9+] If an integer is given, a transient will be used. If an array of option key arguments is given, the argument values will be set to the framework properties.
      * - type - either `options_table` or `transient`.
      * - key - the option key or the transient key
@@ -85,6 +85,7 @@ 
         /**
          * Returns the script caller path.
          * @remark      It is important to find the caller script path here when separating the library into multiple files.
+         * @param string|null $sCallerPath
          * @return      null|string
          * @since       3.8.2
          */

Spacing +6 added lines, -6 removed lines

@@ -68,9 +68,9 @@ 
      * @param       string                  $sCapability    (optional) sets the overall access level to the admin pages created by the framework. The used capabilities are listed <a href="http://codex.wordpress.org/Roles_and_Capabilities">here</a>. The capability can be set per page, tab, setting section, setting field. Default: `manage_options`
      * @param       string                  $sTextDomain    (optional) the <a href="http://codex.wordpress.org/I18n_for_WordPress_Developers#Text_Domains" target="_blank">text domain</a> used for the framework's system messages. Default: admin-page-framework.
      */
-    public function __construct( $isOptionKey=null, $sCallerPath=null, $sCapability='manage_options', $sTextDomain='admin-page-framework' ){
+    public function __construct( $isOptionKey = null, $sCallerPath = null, $sCapability = 'manage_options', $sTextDomain = 'admin-page-framework' ) {
 
-        if ( ! $this->_isInstantiatable() ) {
+        if ( !$this->_isInstantiatable() ) {
             return;
         }
                         
@@ -90,19 +90,19 @@ 
          */
         private function _getCallerPath( $sCallerPath ) {
             
-            if ( $sCallerPath  ) {
+            if ( $sCallerPath ) {
                 return trim( $sCallerPath );
             }
             
-            if ( ! is_admin() ) {
+            if ( !is_admin() ) {
                 return null;
             }
             
-            if ( ! isset( $GLOBALS[ 'pagenow' ] ) ) {
+            if ( !isset( $GLOBALS[ 'pagenow' ] ) ) {
                 return null;
             }
             
-            $_sCalllerPath = in_array( $GLOBALS[ 'pagenow' ], array( 'plugins.php', ) ) || isset( $_GET[ 'page' ] )
+            $_sCalllerPath = in_array( $GLOBALS[ 'pagenow' ], array( 'plugins.php',) ) || isset( $_GET[ 'page' ] )
                 ? AdminPageFramework_Utility::getCallerScriptPath( __FILE__ ) // not using $oUtil as this method is caller earlier than the base constructor.
                 : null;
                 

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

Spacing +7 added lines, -7 removed lines

@@ -29,8 +29,8 @@ 
     static public function getRelativePath( $from, $to ) {
         
         // some compatibility fixes for Windows paths
-        $from = is_dir( $from ) ? rtrim( $from, '\/') . '/' : $from;
-        $to   = is_dir( $to )   ? rtrim( $to, '\/') . '/'   : $to;
+        $from = is_dir( $from ) ? rtrim( $from, '\/' ).'/' : $from;
+        $to   = is_dir( $to ) ? rtrim( $to, '\/' ).'/' : $to;
         $from = str_replace( '\\', '/', $from );
         $to   = str_replace( '\\', '/', $to );
 
@@ -38,21 +38,21 @@ 
         $to       = explode( '/', $to );
         $relPath  = $to;
 
-        foreach( $from as $depth => $dir ) {
+        foreach ( $from as $depth => $dir ) {
             // find first non-matching dir
-            if( $dir === $to[ $depth ] ) {
+            if ( $dir === $to[ $depth ] ) {
                 // ignore this directory
                 array_shift( $relPath );
             } else {
                 // get number of remaining dirs to $from
                 $remaining = count( $from ) - $depth;
-                if( $remaining > 1 ) {
+                if ( $remaining > 1 ) {
                     // add traversals up to first matching dir
                     $padLength = ( count( $relPath ) + $remaining - 1 ) * -1;
                     $relPath = array_pad( $relPath, $padLength, '..' );
                     break;
                 } else {
-                    $relPath[ 0 ] = './' . $relPath[ 0 ];
+                    $relPath[ 0 ] = './'.$relPath[ 0 ];
                 }
             }
         }
@@ -81,7 +81,7 @@ 
                 6, // the second parameter: limit
             )
         );
-        foreach( $_aBackTrace as $_aDebugInfo )  {     
+        foreach ( $_aBackTrace as $_aDebugInfo ) {     
             $_sCallerFilePath = $_aDebugInfo[ 'file' ];
             if ( in_array( $_sCallerFilePath, $_aRedirectedFilePaths ) ) { 
                 continue; 

Braces +2 added lines, -2 removed lines

@@ -81,9 +81,9 @@
                 6, // the second parameter: limit
             )
         );
-        foreach( $_aBackTrace as $_aDebugInfo )  {     
+        foreach( $_aBackTrace as $_aDebugInfo ) {
             $_sCallerFilePath = $_aDebugInfo[ 'file' ];
-            if ( in_array( $_sCallerFilePath, $_aRedirectedFilePaths ) ) { 
+            if ( in_array( $_sCallerFilePath, $_aRedirectedFilePaths ) ) {
                 continue; 
             }
             break; // catch the first found item.

admin-page-framework-loader.php

Spacing +22 added lines, -22 removed lines

@@ -16,9 +16,9 @@ 
  */
 class AdminPageFrameworkLoader_Registry_Base {
 
-    const VERSION        = '3.8.2';    // <--- DON'T FORGET TO CHANGE THIS AS WELL!!
+    const VERSION        = '3.8.2'; // <--- 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