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.27';    // <--- DON'T FORGET TO CHANGE THIS AS WELL!!
+    const VERSION        = '3.8.27'; // <--- 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' ) && 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

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

Spacing +12 added lines, -12 removed lines

@@ -25,9 +25,9 @@ 
      * @since  3.8.24
      */
     static public function getHTTPRequestSanitized( array $aRequest, $bStripSlashes ) {
-        foreach( $aRequest as $_isIndex => $_mValue ) {
+        foreach ( $aRequest as $_isIndex => $_mValue ) {
             if ( is_array( $_mValue ) ) {
-                $aRequest[ $_isIndex ] = self::getHTTPRequestSanitized( $_mValue, false );  // do not double-strip
+                $aRequest[ $_isIndex ] = self::getHTTPRequestSanitized( $_mValue, false ); // do not double-strip
                 continue;
             }
             if ( is_string( $_mValue ) ) {
@@ -47,10 +47,10 @@ 
          * @sicne  3.8.25
          * @see    _sanitize_text_fields()
          */
-        static private function ___getHTTPRequestTextValueSanitized( $sString, $bKeepLineFeeds=true ) {
+        static private function ___getHTTPRequestTextValueSanitized( $sString, $bKeepLineFeeds = true ) {
             
             $_sFiltered = wp_check_invalid_utf8( $sString );
-            if ( ! $bKeepLineFeeds ) {
+            if ( !$bKeepLineFeeds ) {
                 $_sFiltered = preg_replace( '/[\r\n\t ]+/', ' ', $_sFiltered );
             }
             $_sFiltered = trim( $_sFiltered );
@@ -99,7 +99,7 @@ 
      * @return mixed
      * @since  3.8.24
      */
-    static public function getObjectCache( $asName, $mDefault=null ) {
+    static public function getObjectCache( $asName, $mDefault = null ) {
         return self::getArrayValueByArrayKeys( self::$___aObjectCache, self::getAsArray( $asName ), $mDefault );
     }
 
@@ -114,9 +114,9 @@ 
      * @param   string $sProgramName
      * @since   3.8.8
      */
-    static public function showDeprecationNotice( $sDeprecated, $sAlternative='', $sProgramName='Admin Page Framework' ) {
+    static public function showDeprecationNotice( $sDeprecated, $sAlternative = '', $sProgramName = 'Admin Page Framework' ) {
         trigger_error(
-            $sProgramName . ': ' . sprintf(
+            $sProgramName.': '.sprintf(
                 $sAlternative
                     ? '<code>%1$s</code> has been deprecated. Use <code>%2$s</code> instead.'
                     : '<code>%1$s</code> has been deprecated.',
@@ -139,8 +139,8 @@ 
      * @param       string|array        $asParameters       Parameters to pass to the callback function.
      * @return      mixed
      */
-    public function callBack( $oCallable, $asParameters=array() ) {
-        $_aParameters   = self::getAsArray(
+    public function callBack( $oCallable, $asParameters = array() ) {
+        $_aParameters = self::getAsArray(
             $asParameters,
             true // preserve empty
         );
@@ -179,7 +179,7 @@ 
      * @param       array       $aParameters
      * @return      string      The captured output buffer.
      */
-    static public function getOutputBuffer( $cCallable, array $aParameters=array() ) {
+    static public function getOutputBuffer( $cCallable, array $aParameters = array() ) {
 
         ob_start();
         echo call_user_func_array( $cCallable, $aParameters );
@@ -201,7 +201,7 @@ 
 
         $_iCount     = count( get_object_vars( $oInstance ) );
         $_sClassName = get_class( $oInstance );
-        return '(object) ' . $_sClassName . ': ' . $_iCount . ' properties.';
+        return '(object) '.$_sClassName.': '.$_iCount.' properties.';
 
     }
 
@@ -218,7 +218,7 @@ 
      * @param       boolean|integer|double|string|array|object|resource|NULL        $mFalse     The value to return when the first parameter value yields false.
      * @return      mixed
      */
-    static public function getAOrB( $mValue, $mTrue=null, $mFalse=null ) {
+    static public function getAOrB( $mValue, $mTrue = null, $mFalse = null ) {
         return $mValue ? $mTrue : $mFalse;
     }
 

development/factory/_common/form/_model/AdminPageFramework_Form_Model___DefaultValues.php

Spacing +14 added lines, -14 removed lines

@@ -16,7 +16,7 @@ 
  */
 class AdminPageFramework_Form_Model___DefaultValues extends AdminPageFramework_Form_Base {
 
-    public $aFieldsets  = array();
+    public $aFieldsets = array();
 
     /**
      * Sets up hooks.
@@ -27,7 +27,7 @@ 
         $_aParameters = func_get_args() + array(
             $this->aFieldsets,
         );
-        $this->aFieldsets  = $_aParameters[ 0 ];
+        $this->aFieldsets = $_aParameters[ 0 ];
 
     }
 
@@ -80,12 +80,12 @@ 
          * @return  array
          */
         private function ___getDefaultValues( $aFieldsets, $aDefaultOptions ) {
-            foreach( $aFieldsets as $_sSectionPath => $_aItems ) {
+            foreach ( $aFieldsets as $_sSectionPath => $_aItems ) {
                 $_aSectionPath   = explode( '|', $_sSectionPath );
-                foreach( $_aItems as $_sFieldPath => $_aFieldset ) {
+                foreach ( $_aItems as $_sFieldPath => $_aFieldset ) {
                     $_aFieldPath = explode( '|', $_sFieldPath );
                     $this->setMultiDimensionalArray(
-                        $aDefaultOptions,  // by reference
+                        $aDefaultOptions, // by reference
                         '_default' === $_sSectionPath
                             ? array( $_sFieldPath )
                             : array_merge( $_aSectionPath, $_aFieldPath ), // key address
@@ -114,11 +114,11 @@ 
             // If there are no sub-fields
             if ( count( $_aSubFields ) === 0 ) {
                 return $this->getElement(
-                    $aFieldset,           // subject
-                    'value',        // key
+                    $aFieldset, // subject
+                    'value', // key
                     $this->getElement(    // default value
-                        $aFieldset,       // subject
-                        'default',  // key
+                        $aFieldset, // subject
+                        'default', // key
                         null      // default value
                     )
                 );
@@ -127,13 +127,13 @@ 
             // Otherwise, there are sub-fields
             $_aDefault = array();
             array_unshift( $_aSubFields, $aFieldset ); // insert the main field into the very first index.
-            foreach( $_aSubFields as $_iIndex => $_aField ) {
+            foreach ( $_aSubFields as $_iIndex => $_aField ) {
                 $_aDefault[ $_iIndex ] = $this->getElement(
-                    $_aField,               // subject
-                    'value',          // key
+                    $_aField, // subject
+                    'value', // key
                     $this->getElement(      // default value
-                        $_aField,           // subject
-                        'default',    // key
+                        $_aField, // subject
+                        'default', // key
                         null        // default value
                     )
                 );

development/factory/_common/form/AdminPageFramework_Form_Base.php

Spacing +4 added lines, -4 removed lines

@@ -93,18 +93,18 @@ 
         }
 
         // If the section ID is not registered, return false.
-        if ( ! array_key_exists( $sID, $this->aSectionsets ) ) {
+        if ( !array_key_exists( $sID, $this->aSectionsets ) ) {
             return false;
         }
 
         // the fields array's first dimension is also filled with the keys of section ids.
-        if ( ! array_key_exists( $sID, $this->aFieldsets ) ) {
+        if ( !array_key_exists( $sID, $this->aFieldsets ) ) {
             return false;
         }
 
         // Since numeric IDs are denied at the beginning of the method, the elements will not be sub-sections.
         $_bIsSection = false;
-        foreach( $this->aFieldsets as $_sSectionID => $_aFields ) {
+        foreach ( $this->aFieldsets as $_sSectionID => $_aFields ) {
 
             if ( $_sSectionID == $sID ) {
                 $_bIsSection = true;
@@ -130,7 +130,7 @@ 
      * @return      boolean
      */
     public function canUserView( $sCapability ) {
-        if ( ! $sCapability  ) {
+        if ( !$sCapability ) {
             return true;
         }
         return ( boolean ) current_user_can( $sCapability );

development/factory/_common/form/AdminPageFramework_Form_Model.php

Spacing +20 added lines, -20 removed lines

@@ -64,16 +64,16 @@ 
      * @return array
      * @since  3.7.0
      */
-    public function getSubmittedData( array $aDataToParse, $bExtractFromFieldStructure=true, $bStripSlashes=true ) {
+    public function getSubmittedData( array $aDataToParse, $bExtractFromFieldStructure = true, $bStripSlashes = true ) {
                 
         // Extracts the form data from the subject data for parsing
-        $_aSubmittedFormData    = $bExtractFromFieldStructure
+        $_aSubmittedFormData = $bExtractFromFieldStructure
             ? $this->castArrayContents( 
                 $this->getDataStructureFromAddedFieldsets(), // form data (options) structure
                 $aDataToParse   // the subject data array, usually $_POST.
             )
             : $aDataToParse;
-        $_aSubmittedFormData    = $this->getHTTPRequestSanitized( $_aSubmittedFormData, $bStripSlashes );
+        $_aSubmittedFormData = $this->getHTTPRequestSanitized( $_aSubmittedFormData, $bStripSlashes );
         return $this->getSortedInputs( $_aSubmittedFormData ); // [3.6.0] - sorts dynamic elements.
         
     }
@@ -96,12 +96,12 @@ 
             array_merge(
                 $this->getElementAsArray( 
                     $_POST,
-                    '__repeatable_elements_' . $this->aArguments[ 'structure_type' ],
+                    '__repeatable_elements_'.$this->aArguments[ 'structure_type' ],
                     array()
                 ),
                 $this->getElementAsArray( 
                     $_POST,
-                    '__sortable_elements_' . $this->aArguments[ 'structure_type' ],
+                    '__sortable_elements_'.$this->aArguments[ 'structure_type' ],
                     array()
                 )
             )
@@ -160,9 +160,9 @@ 
      * Changed the name from `getFieldsModel()`.
      * @return      array
      */
-    public function getDataStructureFromAddedFieldsets()  {
+    public function getDataStructureFromAddedFieldsets() {
                     
-        $_aFormDataStructure  = array();
+        $_aFormDataStructure = array();
         foreach ( $this->getAsArray( $this->aFieldsets ) as $_sSectionID => $_aFieldsets ) {
 
             if ( $_sSectionID !== '_default' ) {
@@ -171,7 +171,7 @@ 
             }
             
             // For default field items.
-            foreach( $_aFieldsets as $_sFieldID => $_aFieldset ) {
+            foreach ( $_aFieldsets as $_sFieldID => $_aFieldset ) {
                 $_aFormDataStructure[ $_aFieldset[ 'field_id' ] ] = $_aFieldset;
             }
 
@@ -203,7 +203,7 @@ 
             $aSubject,
             $this->getElementAsArray(
                 $_POST,
-                '__repeatable_elements_' . $this->aArguments[ 'structure_type' ]
+                '__repeatable_elements_'.$this->aArguments[ 'structure_type' ]
             )
         );
         return $_oFilterRepeatableElements->get();
@@ -216,13 +216,13 @@ 
     public function _replyToRegisterFormItems() {
 
         // Check if the form should be created or not.
-        if ( ! $this->isInThePage() ) {
+        if ( !$this->isInThePage() ) {
             return;
         }
 
         // Load field type definitions.
-        $this->_setFieldTypeDefinitions( 'admin_page_framework' );    // site-wide
-        $this->_setFieldTypeDefinitions( $this->aArguments[ 'caller_id' ] );   // per class
+        $this->_setFieldTypeDefinitions( 'admin_page_framework' ); // site-wide
+        $this->_setFieldTypeDefinitions( $this->aArguments[ 'caller_id' ] ); // per class
         
         // Set the options array
         $this->aSavedData = $this->_getSavedData(
@@ -250,7 +250,7 @@ 
             $this->aArguments,
             $this->aFieldsets,
             self::$_aResources,
-            $this->aFieldTypeDefinitions,   // must be called after performing `_setFieldTypeDefinitions()`.
+            $this->aFieldTypeDefinitions, // must be called after performing `_setFieldTypeDefinitions()`.
             $this->aCallbacks
         );
         self::$_aResources = $_oFieldResources->get(); // updates the property
@@ -267,10 +267,10 @@ 
         $this->callBack(
             $this->aCallbacks[ 'handle_form_data' ],
             array(
-                $this->aSavedData,      // 1st parameter
-                $this->aArguments,      // 2nd parameter
-                $this->aSectionsets,    // 3rd parameter
-                $this->aFieldsets,      // 4th parameter
+                $this->aSavedData, // 1st parameter
+                $this->aArguments, // 2nd parameter
+                $this->aSectionsets, // 3rd parameter
+                $this->aFieldsets, // 4th parameter
             )
         );        
 
@@ -284,15 +284,15 @@ 
             $this->aSectionsets = $this->callBack(
                 $this->aCallbacks[ 'sectionsets_before_registration' ],
                 array(
-                    $this->aSectionsets,    // 1st parameter
+                    $this->aSectionsets, // 1st parameter
                 )
             );
             // Let the main routine modify the fieldsets definition array.
             $this->aFieldsets = $this->callBack(
                 $this->aCallbacks[ 'fieldsets_before_registration' ],
                 array(
-                    $this->aFieldsets,    // 1st parameter
-                    $this->aSectionsets,  // 2nd parameter
+                    $this->aFieldsets, // 1st parameter
+                    $this->aSectionsets, // 2nd parameter
                 )
             );
 

Braces +3 added lines, -3 removed lines

@@ -46,7 +46,7 @@ 
                 array( $this, '_replyToRegisterFormItems' ),
                 100 // priority - low value is set as meta boxes use the `current_screen` action hook for `setUp()`.
             );
-        } else {                
+        } else {
             add_action(
                 $this->aArguments[ 'action_hook_form_registration' ],
                 array( $this, '_replyToRegisterFormItems' )
@@ -160,7 +160,7 @@ 
      * Changed the name from `getFieldsModel()`.
      * @return      array
      */
-    public function getDataStructureFromAddedFieldsets()  {
+    public function getDataStructureFromAddedFieldsets() {
                     
         $_aFormDataStructure  = array();
         foreach ( $this->getAsArray( $this->aFieldsets ) as $_sSectionID => $_aFieldsets ) {
@@ -198,7 +198,7 @@ 
      * @param       array       $aSubject       The subject array to modify. Usually the saved option data.
      * @return      array       The modified options array.
      */
-    public function dropRepeatableElements( array $aSubject ) {        
+    public function dropRepeatableElements( array $aSubject ) {
         $_oFilterRepeatableElements = new AdminPageFramework_Form_Model___Modifier_FilterRepeatableElements( 
             $aSubject,
             $this->getElementAsArray(

development/factory/_common/form/_view/sectionset/AdminPageFramework_Form_View___FieldsetRows.php

Spacing +3 added lines, -3 removed lines

@@ -58,7 +58,7 @@ 
      * @return      string
      * @since       3.7.0
      */
-    public function get( $bTableRow=true ) {
+    public function get( $bTableRow = true ) {
 
         $_sMethodName = $this->getAOrB(
             $bTableRow,
@@ -67,7 +67,7 @@ 
         );
 
         $_sOutput = '';
-        foreach( $this->aFieldsetsPerSection as $_aFieldset ) {
+        foreach ( $this->aFieldsetsPerSection as $_aFieldset ) {
 
             $_oFieldsetOutputFormatter = new AdminPageFramework_Form_Model___Format_FieldsetOutput(
                 $_aFieldset,
@@ -76,7 +76,7 @@ 
             );
 
             $_aFieldset = $_oFieldsetOutputFormatter->get();
-            if ( ! $this->callBack( $this->aCallbacks[ 'is_fieldset_visible' ], array( true, $_aFieldset ) ) ) {
+            if ( !$this->callBack( $this->aCallbacks[ 'is_fieldset_visible' ], array( true, $_aFieldset ) ) ) {
                 continue;
             }