michaeluno / admin-page-framework

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

Doc Comments +4 added lines, -5 removed lines

@@ -259,6 +259,7 @@ 
          * Generates the framework zip data.
          *
          * @since       3.5.4
+         * @param string $sFrameworkDirPath
          * @return      string      The binary zip data.
          */
         private function _getDownloadFrameworkZipFile( $sFrameworkDirPath, $sDestinationPath ) {
@@ -310,11 +311,7 @@ 
                  *
                  * @since       3.5.4
                  * @remark      string      $sPath              The path to check. It can be a directory or a file.
-                 * @param       string      $sPathInArchive     The parsing directory path set to the archive.
-                 * The passed path for the archive has a trailing slash. It starts with a directory name.
-                 * e.g.
-                 * `utility/AdminPageFramework_WPReadmeParser/`
-                 * `factory/widget/model/`
+                 * @param string $sPath
                  * @return      boolean
                  */
                 private function _isAllowedArchivePath( $sPath ) {
@@ -578,6 +575,7 @@ 
                  * Modifies the text domain in the given file contents.
                  *
                  * @since       3.5.4
+                 * @param string $sFileContents
                  * @return      string
                  */
                 private function _modifyTextDomain( $sFileContents ) {
@@ -596,6 +594,7 @@ 
                      * Retrieves the value from the $_POST array by the given field ID.
                      *
                      * @since       3.5.4
+                     * @param string $sFieldID
                      * @return      string
                      */
                     private function _getFormSubmitValueByFieldIDAsString( $sFieldID ) {

Spacing +32 added lines, -32 removed lines

@@ -30,7 +30,7 @@ 
         $this->oFactory = $oFactory;
 
         add_action(
-            'export_name_' . $this->sPageSlug . '_' . $this->sTabSlug,
+            'export_name_'.$this->sPageSlug.'_'.$this->sTabSlug,
             array( $this, 'replyToFilterFileName' ),
             10,
             5
@@ -127,8 +127,8 @@ 
                 'label_min_width'   => 0,
                 'order'             => 100,
                 'value'             => __( 'Download', 'adimn-page-framework-demo' ),
-                'file_name'         => 'admin-page-framework.zip',  // the default file name. This will be modified by the filter.
-                'format'            => 'text',  // 'json', 'text', 'array'
+                'file_name'         => 'admin-page-framework.zip', // the default file name. This will be modified by the filter.
+                'format'            => 'text', // 'json', 'text', 'array'
                 'description'       => $oFactory->oUtil->getAOrB(
                     class_exists( 'ZipArchive' ),
                     __( 'Download the compiled framework files as a zip file.', 'admin-page-framework-loader' ),
@@ -183,8 +183,8 @@ 
 
         // the class prefix must not contain white spaces and some other characters not supported in PHP class names.
         preg_match(
-            '/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/',     // pattern - allowed characters for variables in PHP.
-            $aInput[ 'class_prefix' ],     // subject
+            '/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', // pattern - allowed characters for variables in PHP.
+            $aInput[ 'class_prefix' ], // subject
             $_aMatches
         );
         if ( $aInput[ 'class_prefix' ] && empty( $_aMatches ) ) {
@@ -192,13 +192,13 @@ 
             $_bVerified = false;
         }
 
-        if ( ! $aInput[ 'text_domain' ] ) {
+        if ( !$aInput[ 'text_domain' ] ) {
             $_aErrors[ $this->sSectionID ][ 'text_domain' ] = __( 'The text domain cannot be empty.', 'admin-page-framework-loader' );
             $_bVerified = false;
         }
 
         // An invalid value is found. Set a field error array and an admin notice and return the old values.
-        if ( ! $_bVerified ) {
+        if ( !$_bVerified ) {
             $oAdminPage->setFieldErrors( $_aErrors );
             $oAdminPage->setSettingNotice( __( 'There was something wrong with your input.', 'admin-page-framework-loader' ) );
             return $aOldInput;
@@ -240,8 +240,8 @@ 
      */
     public function replyToDownloadFramework( $aSavedData, $sSubmittedFieldID, $sSubmittedInputID, $oAdminPage ) {
 
-        $_sFrameworkDirPath = AdminPageFrameworkLoader_Registry::$sDirPath . '/library/apf';
-        if ( ! file_exists( $_sFrameworkDirPath ) ) {
+        $_sFrameworkDirPath = AdminPageFrameworkLoader_Registry::$sDirPath.'/library/apf';
+        if ( !file_exists( $_sFrameworkDirPath ) ) {
             return $aSavedData;
         }
 
@@ -250,7 +250,7 @@ 
             $_sFrameworkDirPath,
             $_sTempFile
         );
-        header( "Content-Length: " . strlen( $_sData ) );
+        header( "Content-Length: ".strlen( $_sData ) );
         unlink( $_sTempFile );
         return $_sData;
 
@@ -267,9 +267,9 @@ 
                 $sFrameworkDirPath,
                 $sDestinationPath,
                 array(
-                    'include_directory'             => false,   // wrap contents in a sub-directory
+                    'include_directory'             => false, // wrap contents in a sub-directory
                     'additional_source_directories' => apply_filters(
-                        AdminPageFrameworkLoader_Registry::HOOK_SLUG . '_filter_generator_additional_source_directories',
+                        AdminPageFrameworkLoader_Registry::HOOK_SLUG.'_filter_generator_additional_source_directories',
                         array() // directory paths
                     ),
                 ),
@@ -280,7 +280,7 @@ 
                 )
             );
             $_bSucceed = $_oZip->compress();
-            if ( ! $_bSucceed ) {
+            if ( !$_bSucceed ) {
                 return '';
             }
             return file_get_contents( $sDestinationPath );
@@ -300,7 +300,7 @@ 
 
                 // Check if it belongs to selected components.
                 if ( false === $this->_isAllowedArchivePath( $sPathInArchive ) ) {
-                    return '';  // empty value will drop the entry
+                    return ''; // empty value will drop the entry
                 }
                 return $sPathInArchive;
 
@@ -319,7 +319,7 @@ 
                  */
                 private function _isAllowedArchivePath( $sPath ) {
 
-                    foreach( $this->_getDisallowedArchiveDirectoryPaths() as $_sDisallowedPath ) {
+                    foreach ( $this->_getDisallowedArchiveDirectoryPaths() as $_sDisallowedPath ) {
                         $_bHasPrefix = $this->oFactory->oUtil->hasPrefix(
                             ltrim( $_sDisallowedPath, '/' ), // needle
                             ltrim( $sPath, '/' ) // haystack
@@ -392,7 +392,7 @@ 
                     // List paths.
                     $_aAllComponentsPaths       = array();
                     $_aSelectedComponentsPaths  = array();
-                    foreach( $this->_aComponentPaths as $_sKey => $_aPaths ) {
+                    foreach ( $this->_aComponentPaths as $_sKey => $_aPaths ) {
 
                         // Extract all component paths.
                         $_aAllComponentsPaths = array_merge(
@@ -447,16 +447,16 @@ 
 
                 // 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;
                 }
 
                 // Modify the file contents.
                 $sFileContents = apply_filters(
-                    AdminPageFrameworkLoader_Registry::HOOK_SLUG . '_filter_generator_file_contents',
+                    AdminPageFrameworkLoader_Registry::HOOK_SLUG.'_filter_generator_file_contents',
                     $sFileContents,
                     $sPathInArchive,
                     $this->oFactory->oUtil->getElement(
@@ -517,12 +517,12 @@ 
                             $this->_getCheckedComponents()
                         );
                         $_aInsert = array(
-                            'Included Components: ' . implode( ', ', $_aCheckedComponents ),
-                            'Generated on ' . date( 'Y-m-d' ),  // today's date
+                            'Included Components: '.implode( ', ', $_aCheckedComponents ),
+                            'Generated on '.date( 'Y-m-d' ), // today's date
                         );
                         return preg_replace(
                             '#\*/#', // needle - matches '*/'
-                            implode( PHP_EOL . ' ', $_aInsert ) . ' \0', // replacement \0 is a back-reference to '*/'
+                            implode( PHP_EOL.' ', $_aInsert ).' \0', // replacement \0 is a back-reference to '*/'
                             $sFileContents, // subject
                             1 // replace only the first occurrence
                         );
@@ -536,14 +536,14 @@ 
                     private function _modifyClassNameOfInclusionList( $sFileContents ) {
                         // Replace the array key names.
                         $sFileContents = preg_replace_callback(
-                            '/(["\'])(.+)\1(?=\s?+=>)/',  // pattern '
-                            array( $this, '_replyToModifyPathName' ),   // callable
+                            '/(["\'])(.+)\1(?=\s?+=>)/', // pattern '
+                            array( $this, '_replyToModifyPathName' ), // callable
                             $sFileContents // subject
                         );
                         // Replace the registry class names.
                         return preg_replace_callback(
-                            '/(=>\s?+)(.+)(?=::)/',  // pattern '
-                            array( $this, '_replyToModifyPathName' ),   // callable
+                            '/(=>\s?+)(.+)(?=::)/', // pattern '
+                            array( $this, '_replyToModifyPathName' ), // callable
                             $sFileContents // subject
                         );
                     }
@@ -568,7 +568,7 @@ 
                     return strlen( $_sPrefix )
                         ? str_replace(
                             'AdminPageFramework', // search
-                            $_sPrefix . 'AdminPageFramework', // replace
+                            $_sPrefix.'AdminPageFramework', // replace
                             $sSubject // subject
                         )
                         : $sSubject;
@@ -600,7 +600,7 @@ 
                      */
                     private function _getFormSubmitValueByFieldIDAsString( $sFieldID ) {
 
-                        static $_aCaches=array();
+                        static $_aCaches = array();
                         $_aCaches[ $sFieldID ] = isset( $_aCaches[ $sFieldID ] )
                             ? $_aCaches[ $sFieldID ]
                             : $this->oFactory->oUtil->getElement(
@@ -634,9 +634,9 @@ 
                 'public',
             ),
             'Content-Description'       => 'File Transfer',
-            'Content-type'              => 'application/octet-stream',   // 'application/zip' may work as well
+            'Content-type'              => 'application/octet-stream', // 'application/zip' may work as well
             'Content-Transfer-Encoding' => 'binary',
-            'Content-Disposition'       => 'attachment; filename="' . $sFileName .'";',
+            'Content-Disposition'       => 'attachment; filename="'.$sFileName.'";',
             // 'Content-Length'            => strlen( $mData ),
         ) + $aHeader;
 
@@ -673,10 +673,10 @@ 
         $_sFileNameWOExtension = trim( $_sFileNameWOExtension );
         return $this->oFactory->oUtil->getAOrB(
                 $_sFileNameWOExtension,
-                $_sFileNameWOExtension . '-admin-page-framework',
+                $_sFileNameWOExtension.'-admin-page-framework',
                 'admin-page-framework'
             )
-            . '.' . AdminPageFramework_Registry::VERSION
+            . '.'.AdminPageFramework_Registry::VERSION
             . '.zip';
 
     }

include/class/admin/admin-page-framework/tool/minifier/AdminPageFrameworkLoader_AdminPage_Tool_Minifier_Minifier.php

Doc Comments +1 added lines

@@ -139,6 +139,7 @@
          * Modifies the class names of the minified script.
          *
          * @since       3.4.6
+         * @param string $sCode
          */
         private function _modifyClassNames( $sCode ) {
 

Spacing +9 added lines, -9 removed lines

@@ -26,7 +26,7 @@ 
             4
         );
         add_action(
-            'export_name_' . $this->sPageSlug . '_' . $this->sTabSlug,
+            'export_name_'.$this->sPageSlug.'_'.$this->sTabSlug,
             array( $this, 'replyToFilterFileName' ), 10, 5
         );
 
@@ -41,7 +41,7 @@ 
                 'title'             => __( 'Class Prefix', 'admin-page-framework-loader' ),
                 'type'              => 'text',
                 'description'       => __( 'Set alphanumeric characters for the class names', 'admin-page-framework-loader' )
-                    . ' ' .  __( 'For example, if you set here <code>MyPluginName_</code>, you will need to extend the class named <code>MyClassName_AdminPageFramework</code> instead of <code>AdminPageFramework</code>.', 'admin-page-framework-loader' )
+                    . ' '.__( 'For example, if you set here <code>MyPluginName_</code>, you will need to extend the class named <code>MyClassName_AdminPageFramework</code> instead of <code>AdminPageFramework</code>.', 'admin-page-framework-loader' )
                     . ' e.g.<code>MyPluginName_</code>',
                 'attributes'        => array(
                     'size'          => 30,
@@ -68,8 +68,8 @@ 
                 'type'              => 'export',
                 'label_min_width'   => 0,
                 'value'             => __( 'Download', 'adimn-page-framework-demo' ),
-                'file_name'         => 'admin-page-framework.min.php',  // the default file name. This will be modified by the filter.
-                'format'            => 'text',  // 'json', 'text', 'array'
+                'file_name'         => 'admin-page-framework.min.php', // the default file name. This will be modified by the filter.
+                'format'            => 'text', // 'json', 'text', 'array'
                 'description'       => __( 'Download the minified version.', 'admin-page-framework-loader' ),
             )
         );
@@ -101,13 +101,13 @@ 
         if ( $aInput[ 'class_prefix' ] && empty( $_aMatches ) ) {
 
             // $variable[ 'sectioni_id' ]['field_id']
-            $_aErrors['class_prefix'] = __( 'The prefix must consist of alphanumeric with underscores.', 'admin-page-framework-loader' );
+            $_aErrors[ 'class_prefix' ] = __( 'The prefix must consist of alphanumeric with underscores.', 'admin-page-framework-loader' );
             $_bVerified = false;
 
         }
 
         /* 4. An invalid value is found. */
-        if ( ! $_bVerified ) {
+        if ( !$_bVerified ) {
 
             /* 4-1. Set the error array for the input fields. */
             $oAdminPage->setFieldErrors( $_aErrors );
@@ -128,7 +128,7 @@ 
      */
     public function replyToDownloadMinifiedVersion( $aSavedData, $sSubmittedFieldID, $sSubmittedInputID, $oAdminPage ) {
 
-        $_sMinifiedVersionPath = AdminPageFrameworkLoader_Registry::$sDirPath . '/library/admin-page-framework.min.php';
+        $_sMinifiedVersionPath = AdminPageFrameworkLoader_Registry::$sDirPath.'/library/admin-page-framework.min.php';
         if ( file_exists( $_sMinifiedVersionPath ) ) {
             return $this->_modifyClassNames( file_get_contents( $_sMinifiedVersionPath ) );
         }
@@ -147,8 +147,8 @@ 
                 : '';
 
             return str_replace(
-                'AdminPageFramework',         // search
-                $_sPrefix . 'AdminPageFramework',         // replace
+                'AdminPageFramework', // search
+                $_sPrefix.'AdminPageFramework', // replace
                 $sCode // subject
             );
 

development/factory/term_meta/AdminPageFramework_TermMeta_Model.php

Spacing +7 added lines, -7 removed lines

@@ -55,10 +55,10 @@ 
      * @since       3.8.0
      * @internal
      */
-    protected function _setOptionArray( $iTermID=null, $_deprecated=null ) {
+    protected function _setOptionArray( $iTermID = null, $_deprecated = null ) {
         $this->oForm->aSavedData = $this->oUtil->addAndApplyFilter(
             $this, // the caller factory object
-            'options_' . $this->oProp->sClassName,
+            'options_'.$this->oProp->sClassName,
             $this->_getSavedTermMetas( $iTermID, $this->oForm->aFieldsets )
             // @todo maybe pass the term id because the user will not know whihch form data is
         );
@@ -90,7 +90,7 @@ 
      */
     public function _replyToValidateOptions( $iTermID ) {
 
-        if ( ! $this->_shouldProceedValidation() ) {
+        if ( !$this->_shouldProceedValidation() ) {
             return;
         }
 
@@ -98,19 +98,19 @@ 
         $_aSubmittedFormData    = $this->oForm->getSubmittedData( $_POST );
         $_aSubmittedFormData    = $this->oUtil->addAndApplyFilters(
             $this,
-            'validation_' . $this->oProp->sClassName,
+            'validation_'.$this->oProp->sClassName,
             call_user_func_array(       // 1st param
                 array( $this, 'validate' ), // triggers __call()
                 array( $_aSubmittedFormData, $_aSavedFormData, $this )
             ), // 3.5.10+
-            $_aSavedFormData,   // 2nd param
+            $_aSavedFormData, // 2nd param
             $this   // 3rd param
         );
 
         // @todo Update term metas
         $this->oForm->updateMetaDataByType(
-            $iTermID,  // object id
-            $_aSubmittedFormData,  // user submit form data
+            $iTermID, // object id
+            $_aSubmittedFormData, // user submit form data
             $this->oForm->dropRepeatableElements( $_aSavedFormData ), // Drop repeatable section elements from the saved meta array.
             $this->oForm->sStructureType   // fields type
         );

development/factory/term_meta/AdminPageFramework_TermMeta.php

Spacing +3 added lines, -3 removed lines

@@ -45,7 +45,7 @@ 
      * @param       string          The text domain. Default: `admin-page-framework`.
      * @return      void
      */
-    public function __construct( $asTaxonomySlug, $sCapability='manage_options', $sTextDomain='admin-page-framework' ) {
+    public function __construct( $asTaxonomySlug, $sCapability = 'manage_options', $sTextDomain = 'admin-page-framework' ) {
 
         if ( empty( $asTaxonomySlug ) ) {
             return;
@@ -54,7 +54,7 @@ 
         // Properties
         $_sProprtyClassName = isset( $this->aSubClassNames[ 'oProp' ] )
             ? $this->aSubClassNames[ 'oProp' ]
-            : 'AdminPageFramework_Property_' . $this->_sStructureType;
+            : 'AdminPageFramework_Property_'.$this->_sStructureType;
         $this->oProp        = new $_sProprtyClassName(
             $this,
             get_class( $this ),
@@ -62,7 +62,7 @@ 
             $sTextDomain,
             $this->_sStructureType
         );
-        $this->oProp->aTaxonomySlugs    = ( array ) $asTaxonomySlug;
+        $this->oProp->aTaxonomySlugs = ( array ) $asTaxonomySlug;
 
         parent::__construct( $this->oProp );
 

development/factory/term_meta/AdminPageFramework_TermMeta_View.php

Spacing +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
      * @return      string      the flat input name attribute
      */
     public function _replyToGetFlatInputName( /* $sFlatNameAttribute, $aField, $sKey, $sSectionIndex */ ) {
-        $_aParams   = func_get_args() + array( null, null, null );
+        $_aParams = func_get_args() + array( null, null, null );
         return $_aParams[ 0 ];
     }
 

development/factory/term_meta/_model/AdminPageFramework_TermMeta_Model___TermMeta.php

Spacing +1 added lines, -1 removed lines

@@ -20,6 +20,6 @@
     /**
      * The callback function name or the callable object to retrieve meta data.
      */
-    protected $osCallable   = 'get_term_meta';
+    protected $osCallable = 'get_term_meta';
 
 }

development/factory/term_meta/form/AdminPageFramework_Form_term_meta.php

Spacing +3 added lines, -3 removed lines

@@ -53,7 +53,7 @@ 
             '' // default value
         );
 
-        if ( ! $this->canUserView( $this->sCapability ) ) {
+        if ( !$this->canUserView( $this->sCapability ) ) {
             return '';
         }
 
@@ -81,10 +81,10 @@ 
         );
 
         $_sAddNewTerm     = $bEditTerm ? '' : ' add-new-term';
-        $_sClassSelectors = 'admin-page-framework-form-table-term_meta' . $_sAddNewTerm;
+        $_sClassSelectors = 'admin-page-framework-form-table-term_meta'.$_sAddNewTerm;
         return '<tr class="admin-page-framework-form-table-outer-row-term_meta">'
             . '<td colspan=2>'
-                . '<table class="' . $_sClassSelectors . '">'
+                . '<table class="'.$_sClassSelectors.'">'
                     . '<tbody>'
                         . '<tr>'
                             . '<td>'

development/factory/network_admin_page/_controller/AdminPageFramework_Link_network_admin_page.php

Spacing +3 added lines, -3 removed lines

@@ -22,7 +22,7 @@ 
     /**
      * Sets up hooks and properties.
      */
-    public function __construct( $oProp, $oMsg=null ) {
+    public function __construct( $oProp, $oMsg = null ) {
 
         parent::__construct( $oProp, $oMsg );
 
@@ -30,13 +30,13 @@ 
 
             // This filter for non-network-admin action links is added in the parent constructor.
             remove_filter(
-                'plugin_action_links_' . plugin_basename( $this->oProp->aScriptInfo['sPath'] ),
+                'plugin_action_links_'.plugin_basename( $this->oProp->aScriptInfo[ 'sPath' ] ),
                 array( $this, '_replyToAddSettingsLinkInPluginListingPage' ),
                 20
             );
             // Add the action link filter for the multi-site network admin.
             add_filter(
-                'network_admin_plugin_action_links_' . plugin_basename( $this->oProp->aScriptInfo['sPath'] ),
+                'network_admin_plugin_action_links_'.plugin_basename( $this->oProp->aScriptInfo[ 'sPath' ] ),
                 array( $this, '_replyToAddSettingsLinkInPluginListingPage' )
             );
 

development/factory/network_admin_page/_model/AdminPageFramework_Property_network_admin_page.php

Spacing +2 added lines, -2 removed lines

@@ -51,7 +51,7 @@ 
                 $GLOBALS,
                 array( 'aAdminPageFramework', 'aPageClasses', $this->sClassName )
             ),
-            'options_' . $this->sClassName, // options_{instantiated class name}
+            'options_'.$this->sClassName, // options_{instantiated class name}
             $this->sOptionKey
                 ? get_site_option( $this->sOptionKey, array() )
                 : array()
@@ -69,7 +69,7 @@ 
      * @since       3.1.1       Made it return a boolean value.
      * @return      boolean     True if saved; otherwise, false.
      */
-    public function updateOption( $aOptions=null ) {
+    public function updateOption( $aOptions = null ) {
 
         if ( $this->_bDisableSavingOptions ) {
             return;