michaeluno / admin-page-framework

admin-page-framework-loader.php

Spacing +22 added lines, -22 removed lines

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

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

Spacing +34 added lines, -34 removed lines

@@ -88,7 +88,7 @@ 
                     'class_name'           => 'AceCustomFieldType',
                     'label'                => __( 'ACE', 'admin-page-framework-loader' ),
                     'description'          => __( 'provides code syntax highlighting in a text area field.', 'admin-page-framework-loader' ),
-                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath . '/example/library/ace-custom-field-type',
+                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath.'/example/library/ace-custom-field-type',
                     'archive_file_path'    => 'custom-field-types/ace-custom-field-type/AceCustomFieldType.php',
                     'archive_dir_path'     => 'custom-field-types/ace-custom-field-type',
                     'text_domain'          => 'admin-page-framework',
@@ -97,7 +97,7 @@ 
                     'class_name'           => 'GitHubCustomFieldType',
                     'label'                => __( 'GitHub Buttons', 'admin-page-framework-loader' ),
                     'description'          => __( 'allows you to display GitHub buttons in a field.', 'admin-page-framework-loader' ),
-                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath . '/include/library/github-custom-field-type',
+                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath.'/include/library/github-custom-field-type',
                     'archive_file_path'    => 'custom-field-types/github-custom-field-type/GitHubCustomFieldType.php',
                     'archive_dir_path'     => 'custom-field-types/github-custom-field-type',
                     'text_domain'          => 'admin-page-framework',
@@ -106,7 +106,7 @@ 
                     'class_name'           => 'PathCustomFieldType',
                     'label'                => __( 'Path', 'admin-page-framework-loader' ),
                     'description'          => __( 'allows the user to select a file path on the server.', 'admin-page-framework-loader' ),
-                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath . '/example/library/path-custom-field-type',
+                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath.'/example/library/path-custom-field-type',
                     'archive_file_path'    => 'custom-field-types/path-custom-field-type/PathCustomFieldType.php',
                     'archive_dir_path'     => 'custom-field-types/path-custom-field-type',
                     'text_domain'          => 'admin-page-framework',
@@ -115,7 +115,7 @@ 
                     'class_name'           => 'ToggleCustomFieldType',
                     'label'                => __( 'Toggle', 'admin-page-framework-loader' ),
                     'description'          => __( 'allows the user to switch a button.', 'admin-page-framework-loader' ),
-                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath . '/example/library/toggle-custom-field-type',
+                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath.'/example/library/toggle-custom-field-type',
                     'archive_file_path'    => 'custom-field-types/toggle-custom-field-type/ToggleCustomFieldType.php',
                     'archive_dir_path'     => 'custom-field-types/toggle-custom-field-type',
                     'text_domain'          => 'admin-page-framework',
@@ -124,7 +124,7 @@ 
                     'class_name'           => 'NoUISliderCustomFieldType',
                     'label'                => __( 'NoUISlider (Range Slider)', 'admin-page-framework-loader' ),
                     'description'          => __( 'allows the user to set values in ranges.', 'admin-page-framework-loader' ),
-                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath . '/example/library/nouislider-custom-field-type',
+                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath.'/example/library/nouislider-custom-field-type',
                     'archive_file_path'    => 'custom-field-types/nouislider-custom-field-type/NoUISliderCustomFieldType.php',
                     'archive_dir_path'     => 'custom-field-types/nouislider-custom-field-type',
                     'text_domain'          => 'admin-page-framework',
@@ -133,13 +133,13 @@ 
                 
             // Let third-party scripts add custom field types.
             $this->aCustomFieldTypes = apply_filters(
-                AdminPageFrameworkLoader_Registry::HOOK_SLUG . '_filter_generator_custom_field_types',
+                AdminPageFrameworkLoader_Registry::HOOK_SLUG.'_filter_generator_custom_field_types',
                 $this->aCustomFieldTypes
             );                    
             
-            foreach( $this->aCustomFieldTypes as $_sKey => $_aCustomFieldType ) {
+            foreach ( $this->aCustomFieldTypes as $_sKey => $_aCustomFieldType ) {
                 $this->aCustomFieldTypeLabels[ $_sKey ] = $_aCustomFieldType[ 'label' ]
-                    . ' - <span class="description">' . $_aCustomFieldType[ 'description' ] . '</span>';
+                    . ' - <span class="description">'.$_aCustomFieldType[ 'description' ].'</span>';
             }
      
         }
@@ -155,10 +155,10 @@ 
 
                 // Check the file extension.
                 $_aAllowedExtensions = apply_filters(
-                    AdminPageFrameworkLoader_Registry::HOOK_SLUG . '_filter_generator_allowed_file_extensions',
+                    AdminPageFrameworkLoader_Registry::HOOK_SLUG.'_filter_generator_allowed_file_extensions',
                     array( 'php', 'css', 'js' )
                 );                
-                if ( ! in_array( pathinfo( $sPathInArchive, PATHINFO_EXTENSION ), $_aAllowedExtensions ) ) {
+                if ( !in_array( pathinfo( $sPathInArchive, PATHINFO_EXTENSION ), $_aAllowedExtensions ) ) {
                     return $sFileContents;
                 }            
                 
@@ -188,7 +188,7 @@ 
                 private function _getModifiedInclusionList( $sFileContents ) {
                     return str_replace(
                         ');', // search
-                        $this->_getClassListOfCustomFieldTypes() . ');', // replace - @todo insert the selected class list here
+                        $this->_getClassListOfCustomFieldTypes().');', // replace - @todo insert the selected class list here
                         $sFileContents // subject
                     );
                 }
@@ -205,18 +205,18 @@ 
                             $_POST,
                             array( 
                                 $this->oFactory->oProp->sOptionKey, 
-                                'generator',    // section id
+                                'generator', // section id
                                 'class_prefix'  // field id
                             ),
                             ''
                         );
                         $_aOutput = array();
-                        foreach( $_aCheckedCustomFieldTypes as $_sClassName => $_aCustomFieldType ) {
-                            $_aOutput[] = '    "' . $_sClassPrefix . $_sClassName . '"'
+                        foreach ( $_aCheckedCustomFieldTypes as $_sClassName => $_aCustomFieldType ) {
+                            $_aOutput[ ] = '    "'.$_sClassPrefix.$_sClassName.'"'
                                 . ' => ' 
-                                . 'AdminPageFramework_Registry::$sDirPath . ' . '"/' . ltrim( $_aCustomFieldType[ 'archive_file_path' ], '/' ) . '",';
+                                . 'AdminPageFramework_Registry::$sDirPath . '.'"/'.ltrim( $_aCustomFieldType[ 'archive_file_path' ], '/' ).'",';
                         }
-                        return implode( PHP_EOL, $_aOutput ) . PHP_EOL;
+                        return implode( PHP_EOL, $_aOutput ).PHP_EOL;
                     
                     }
 
@@ -234,7 +234,7 @@ 
                         $this->aCustomFieldTypes // ArchiveFilePaths
                     );
                     $_aArchiveFilePaths = array();
-                    foreach( $_aSelectedCustomFieldTypes as $_sClassName => $_aCustomFieldType ) {
+                    foreach ( $_aSelectedCustomFieldTypes as $_sClassName => $_aCustomFieldType ) {
                         $_aArchiveFilePaths[ $_sClassName ] = $this->oFactory->oUtil->getElement(
                             $_aCustomFieldType,
                             'archive_file_path',
@@ -286,17 +286,17 @@ 
                         array( $sParsingClassName, 'text_domain' )
                     );
                     if ( $_sFieldTypeTextDomain ) {                        
-                        $_aSearches[] = $_sFieldTypeTextDomain;
-                        $_aReplaces[] = $_sUserTextDomain;
+                        $_aSearches[ ] = $_sFieldTypeTextDomain;
+                        $_aReplaces[ ] = $_sUserTextDomain;
                     }
                     
-                    $_aSearches[] = 'admin-page-framework';
-                    $_aReplaces[] = $_sUserTextDomain;
+                    $_aSearches[ ] = 'admin-page-framework';
+                    $_aReplaces[ ] = $_sUserTextDomain;
                     
                     // Return the converted string.
                     return str_replace(
-                        $_aSearches,    // search
-                        $_aReplaces,    // replace
+                        $_aSearches, // search
+                        $_aReplaces, // replace
                         $sFileContents  // subject
                     );
                     
@@ -314,8 +314,8 @@ 
                         );
                                                 
                         return preg_replace(
-                            $this->_getClassPrefixRegexPatterns( $_aSelectedFieldTypeClassNames ),    // search
-                            $this->_getClassPrefixRegexReplacements( $_aSelectedFieldTypeClassNames ),    // replace
+                            $this->_getClassPrefixRegexPatterns( $_aSelectedFieldTypeClassNames ), // search
+                            $this->_getClassPrefixRegexReplacements( $_aSelectedFieldTypeClassNames ), // replace
                             $sFileContents  // subject
                         );
                         
@@ -328,8 +328,8 @@ 
                         private function _getClassPrefixRegexPatterns( array $aSelectedFieldTypeClassNames ) {
 
                             $_aPregSearches = array();
-                            foreach( $aSelectedFieldTypeClassNames as $_sClassName ) {
-                                $_aPregSearches[] = '/(?<=[^a-zA-Z0-9])(' . $_sClassName . ')/';
+                            foreach ( $aSelectedFieldTypeClassNames as $_sClassName ) {
+                                $_aPregSearches[ ] = '/(?<=[^a-zA-Z0-9])('.$_sClassName.')/';
                             }
                             return $_aPregSearches;
                         
@@ -341,9 +341,9 @@ 
                          */
                         private function _getClassPrefixRegexReplacements( array $aSelectedFieldTypeClassNames ) {
 
-                            $_aPrefixedClassNames          = $aSelectedFieldTypeClassNames;
+                            $_aPrefixedClassNames = $aSelectedFieldTypeClassNames;
                             array_walk(
-                                $_aPrefixedClassNames,  // passed by reference
+                                $_aPrefixedClassNames, // passed by reference
                                 array( $this, '_replyToSetPrefix' ),
                                 $this->oFactory->oUtil->getElement(
                                     $_POST,
@@ -364,8 +364,8 @@ 
                              * @callback    function    array_walk
                              * @return      string
                              */
-                            public function _replyToSetPrefix( &$sClassName, $sKey, $sPrefix='' ) {
-                                $sClassName = $sPrefix . '$0';
+                            public function _replyToSetPrefix( &$sClassName, $sKey, $sPrefix = '' ) {
+                                $sClassName = $sPrefix.'$0';
                             }
                                     
  
@@ -386,12 +386,12 @@ 
              */
             public function replyToSetAdditionalDirectoriesForGenerator( $aDirPaths ) {
                                 
-                $_aCheckedCustomFieldTypes        = $this->_getSelectedCustomFieldTypes(
+                $_aCheckedCustomFieldTypes = $this->_getSelectedCustomFieldTypes(
                     $this->aCustomFieldTypes
                 );
                 
                 $_aDirPathInfo = array();
-                foreach( $_aCheckedCustomFieldTypes as $_sKey => $_aCheckedCustomFieldType ) {
+                foreach ( $_aCheckedCustomFieldTypes as $_sKey => $_aCheckedCustomFieldType ) {
                     
                     $_sArchiveDirPath = $this->oFactory->oUtil->getElement( $_aCheckedCustomFieldType, 'archive_dir_path' );
                     $_sSourceDirPath  = $this->oFactory->oUtil->getElement( $_aCheckedCustomFieldType, 'directory_path' );
@@ -407,7 +407,7 @@ 
                  * @return      array       The array keys of the checked items.
                  * @since       3.6.0
                  */
-                private function _getSelectedCustomFieldTypes( array $aSubject=array() ) {
+                private function _getSelectedCustomFieldTypes( array $aSubject = array() ) {
                     
                     $_aCheckedCustomFieldTypes = $this->oFactory->oUtil->getElementAsArray(
                         $_POST,