michaeluno / admin-page-framework

development/factory/_common/form/error/AdminPageFramework_Form___FieldError.php

Doc Comments -5 removed lines

@@ -80,10 +80,6 @@ 
      * `
      * @since        3.7.0
      * @access       public
-     * @param        string      $sMessage       the text message to be displayed.
-     * @param        string      $sType          (optional) the type of the message, either "error" or "updated"  is used.
-     * @param        array       $asAttributes   (optional) the tag attribute array applied to the message container HTML element. If a string is given, it is used as the ID attribute value.
-     * @param        boolean     $bOverride      (optional) If true, only one message will be shown in the next page load. false: do not override when there is a message of the same id. true: override the previous one.
      * @return       void
      */
     public function set( $aErrors ) {
@@ -128,7 +124,6 @@ 
      * Retrieves the settings error array set by the user in the validation callback.
      *
      * @since       3.7.0
-     * @param       boolean     $bDelete    whether or not the transient should be deleted after retrieving it.
      * @return      array
      */
     public function get() {

Spacing +3 added lines, -3 removed lines

@@ -46,7 +46,7 @@ 
             $_sPageSlug = $this->getElement( $_GET, 'page', '' );
             $_sTabSlug  = $this->getElement( $_GET, 'tab', '' );
             $_sUserID   = get_current_user_id();
-            return "apf_fe_" . md5(
+            return "apf_fe_".md5(
                 $_sPageNow
                 . $_sPageSlug
                 . $_sTabSlug
@@ -134,7 +134,7 @@ 
     public function get() {
 
         // Use a cache if exists.
-        self::$_aFieldErrorCaches[ $this->sTransientKey ]  = isset( self::$_aFieldErrorCaches[ $this->sTransientKey ] )
+        self::$_aFieldErrorCaches[ $this->sTransientKey ] = isset( self::$_aFieldErrorCaches[ $this->sTransientKey ] )
             ? self::$_aFieldErrorCaches[ $this->sTransientKey ]
             : $this->getTransient( $this->sTransientKey );
 
@@ -151,7 +151,7 @@ 
      * @since       3.7.0
      */
     public function delete() {
-        if ( $this->hasBeenCalled( 'delete_' . $this->sTransientKey ) ) {
+        if ( $this->hasBeenCalled( 'delete_'.$this->sTransientKey ) ) {
             return;
         }
         add_action( 'shutdown', array( $this, '_replyToDelete' ) );

development/factory/_common/form/field_type/AdminPageFramework_FieldType_size.php

Doc Comments +2 added lines

@@ -211,6 +211,7 @@ 
              * Returns the HTML output of the number input part.
              *
              * @since       3.5.3
+             * @param boolean $bMultiLabels
              * @return      string      The number input output.
              * @internal
              */
@@ -265,6 +266,7 @@ 
              * Returns the HTML output of the unit select input part.
              *
              * @since       3.5.3
+             * @param boolean $bMultiLabels
              * @return      string      The unit select input output.
              * @internal
              */

Spacing +29 added lines, -29 removed lines

@@ -64,7 +64,7 @@ 
     /**
      * Defines the field type slugs used for this field type.
      */
-    public $aFieldTypeSlugs = array( 'size', );
+    public $aFieldTypeSlugs = array( 'size',);
 
     /**
      * Defines the default key-values of this field type.
@@ -73,7 +73,7 @@ 
      */
     protected $aDefaultKeys = array(
         'is_multiple'           => false, // indicates whether the select tag alloes multiple selections.
-        'units'                 => null,  // do not define units here since this will be merged with the user defined field array.
+        'units'                 => null, // do not define units here since this will be merged with the user defined field array.
         'attributes'            => array(
             'size'      => array(
                 'min'           => null,
@@ -101,7 +101,7 @@ 
      */
     protected $aDefaultUnits = array(
         'px'    => 'px', // pixel
-        '%'     => '%',  // percentage
+        '%'     => '%', // percentage
         'em'    => 'em', // font size
         'ex'    => 'ex', // font height
         'in'    => 'in', // inch
@@ -161,8 +161,8 @@ 
         );
 
         $_aOutput = array();
-        foreach( ( array ) $aField[ 'label' ] as $_isKey => $_sLabel ) {
-            $_aOutput[] = $this->_getFieldOutputByLabel(
+        foreach ( ( array ) $aField[ 'label' ] as $_isKey => $_sLabel ) {
+            $_aOutput[ ] = $this->_getFieldOutputByLabel(
                 $_isKey,
                 $_sLabel,
                 $aField
@@ -185,8 +185,8 @@ 
 
             $_aBaseAttributes   = $_bMultiLabels
                 ? array(
-                        'name'  => $aField[ 'attributes' ][ 'name' ] . "[{$isKey}]",
-                        'id'    => $aField[ 'attributes' ][ 'id' ] . "_{$isKey}",
+                        'name'  => $aField[ 'attributes' ][ 'name' ]."[{$isKey}]",
+                        'id'    => $aField[ 'attributes' ][ 'id' ]."_{$isKey}",
                         'value' => $aField[ 'value' ],
                     )
                     + $aField[ 'attributes' ]
@@ -198,9 +198,9 @@ 
 
             $_aOutput = array(
                 $this->getElementByLabel( $aField[ 'before_label' ], $isKey, $aField[ 'label' ] ),
-                    "<div " . $this->getLabelContainerAttributes( $aField, 'admin-page-framework-input-label-container admin-page-framework-select-label' ) . ">",
-                        $this->_getNumberInputPart( $aField, $_aBaseAttributes, $isKey, is_array( $aField[ 'label' ] ) ),  // The size (number) part
-                        $this->_getUnitSelectInput( $aField, $_aBaseAttributes, $isKey, is_array( $aField[ 'label' ] ) ),  // The unit (select) part
+                    "<div ".$this->getLabelContainerAttributes( $aField, 'admin-page-framework-input-label-container admin-page-framework-select-label' ).">",
+                        $this->_getNumberInputPart( $aField, $_aBaseAttributes, $isKey, is_array( $aField[ 'label' ] ) ), // The size (number) part
+                        $this->_getUnitSelectInput( $aField, $_aBaseAttributes, $isKey, is_array( $aField[ 'label' ] ) ), // The unit (select) part
                     "</div>",
                 $this->getElementByLabel( $aField[ 'after_label' ], $isKey, $aField[ 'label' ] )
             );
@@ -217,7 +217,7 @@ 
             private function _getNumberInputPart( array $aField, array $aBaseAttributes, $isKey, $bMultiLabels ) {
 
                 // Size and Size Label
-                $_aSizeAttributes       = $this->_getSizeAttributes(
+                $_aSizeAttributes = $this->_getSizeAttributes(
                     $aField,
                     $aBaseAttributes,
                     $bMultiLabels
@@ -225,32 +225,32 @@ 
                         : ''
                 );
 
-                $_aSizeLabelAttributes  = array(
+                $_aSizeLabelAttributes = array(
                     'for'   => $_aSizeAttributes[ 'id' ],
                     'class' => $_aSizeAttributes[ 'disabled' ]
                         ? 'disabled'
                         : null,
                 );
 
-                $_sLabel                = $this->getElementByLabel(
+                $_sLabel = $this->getElementByLabel(
                     $aField[ 'label' ],
                     $isKey,
                     $aField[ 'label' ]
                 );
-                return "<label " . $this->getAttributes( $_aSizeLabelAttributes ) . ">"
+                return "<label ".$this->getAttributes( $_aSizeLabelAttributes ).">"
                     . $this->getElement(
                         $aField,
                         $bMultiLabels
                             ? array( 'before_label', $isKey, 'size' )
                             : array( 'before_label', 'size' )
                     )
-                    . ( $aField[ 'label' ] && ! $aField[ 'repeatable' ]
-                        ? "<span " . $this->getLabelContainerAttributes( $aField, 'admin-page-framework-input-label-string' ) . ">"
+                    . ( $aField[ 'label' ] && !$aField[ 'repeatable' ]
+                        ? "<span ".$this->getLabelContainerAttributes( $aField, 'admin-page-framework-input-label-string' ).">"
                                 . $_sLabel
                             . "</span>"
                         : ""
                     )
-                    . "<input " . $this->getAttributes( $_aSizeAttributes ) . " />"
+                    . "<input ".$this->getAttributes( $_aSizeAttributes )." />"
                     . $this->getElement(
                         $aField,
                         $bMultiLabels
@@ -293,7 +293,7 @@ 
                     )
                     : $aField[ 'units' ];
 
-                return "<label " . $this->getAttributes(
+                return "<label ".$this->getAttributes(
                         array(
                             'for'       => $_aUnitAttributes[ 'id' ],
                             'class'     => $_aUnitAttributes[ 'disabled' ]
@@ -325,9 +325,9 @@ 
                  * @return      array       an unit attribute array
                  * @internal
                  */
-                private function _getUnitAttributes( array $aField, array $aBaseAttributes, $isLabelKey='' ) {
+                private function _getUnitAttributes( array $aField, array $aBaseAttributes, $isLabelKey = '' ) {
 
-                    $_bIsMultiple    = $aField[ 'is_multiple' ]
+                    $_bIsMultiple = $aField[ 'is_multiple' ]
                         ? true
                         : $this->getElement(
                             $aField,
@@ -339,13 +339,13 @@ 
 
                     $_aSelectAttributes = array(
                         'type'      => 'select',
-                        'id'        => $aField[ 'input_id' ] . ( '' === $isLabelKey ? '' : '_' . $isLabelKey ) . '_' . 'unit',
+                        'id'        => $aField[ 'input_id' ].( '' === $isLabelKey ? '' : '_'.$isLabelKey ).'_'.'unit',
                         'multiple'  => $_bIsMultiple
                             ? 'multiple'
                             : null,
                         'name'      => $_bIsMultiple
-                            ? "{$aField['_input_name']}" . ( '' === $isLabelKey ? '' : '[' . $isLabelKey . ']' ) . "[unit][]"
-                            : "{$aField['_input_name']}" . ( '' === $isLabelKey ? '' : '[' . $isLabelKey . ']' ) . "[unit]",
+                            ? "{$aField[ '_input_name' ]}".( '' === $isLabelKey ? '' : '['.$isLabelKey.']' )."[unit][]"
+                            : "{$aField[ '_input_name' ]}".( '' === $isLabelKey ? '' : '['.$isLabelKey.']' )."[unit]",
                         'value'     => $this->getElement(
                             $aField,
                             array( 'value', 'unit' ),
@@ -357,7 +357,7 @@ 
                         '' === $isLabelKey
                             ? array( 'attributes', 'unit' )
                             : array( 'attributes', $isLabelKey, 'unit' ),
-                        $this->aDefaultKeys['attributes']['unit']
+                        $this->aDefaultKeys[ 'attributes' ][ 'unit' ]
                     )
                     + $aBaseAttributes;
                     return $_aSelectAttributes;
@@ -371,15 +371,15 @@ 
              * @return      array       an size attribute array
              * @internal
              */
-            private function _getSizeAttributes( array $aField, array $aBaseAttributes, $sLabelKey='' ) {
+            private function _getSizeAttributes( array $aField, array $aBaseAttributes, $sLabelKey = '' ) {
 
                 return array(
                         'type'  => 'number',
-                        'id'    => $aField['input_id'] . '_' . ( '' !== $sLabelKey ? $sLabelKey . '_' : '' ) . 'size',
-                        'name'  => $aField[ '_input_name' ] . ( '' !== $sLabelKey ? "[{$sLabelKey}]" : '' ) . '[size]',
+                        'id'    => $aField[ 'input_id' ].'_'.( '' !== $sLabelKey ? $sLabelKey.'_' : '' ).'size',
+                        'name'  => $aField[ '_input_name' ].( '' !== $sLabelKey ? "[{$sLabelKey}]" : '' ).'[size]',
                         'value' => $this->getElement(
-                            $aField,        // subject
-                            array( 'value', 'size' ),   // dimensional keys
+                            $aField, // subject
+                            array( 'value', 'size' ), // dimensional keys
                             ''  // default
                         ),
                     )

development/factory/_common/form/field_type/AdminPageFramework_FieldType_system.php

Doc Comments +3 added lines

@@ -297,6 +297,7 @@ 
             /**
              * Returns the system information by section.
              * @since       3.5.3
+             * @param integer $iPrintType
              * @return      string      The system information by section.
              * @internal
              */
@@ -421,6 +422,8 @@ 
                     /**
                      *
                      * @since       3.5.12
+                     * @param string $asCategories
+                     * @param string $asRemovingCategories
                      * @return      string|array
                      * @internal
                      */

Spacing +59 added lines, -59 removed lines

@@ -72,7 +72,7 @@ 
      * </code>
      * @var         array
      */
-    public $aFieldTypeSlugs = array( 'system', );
+    public $aFieldTypeSlugs = array( 'system',);
 
     /**
      * Defines the default key-values of this field type.
@@ -92,8 +92,8 @@ 
      * @remark          `$_aDefaultKeys` holds shared default key-values defined in the base class.
      */
     protected $aDefaultKeys = array(
-        'data'          =>  array(),        // [3.2.0+] Stores the data to be displayed
-        'print_type'    =>  1,              // [3.4.6+] 1: readable representation of array. 2: print_r()
+        'data'          =>  array(), // [3.2.0+] Stores the data to be displayed
+        'print_type'    =>  1, // [3.4.6+] 1: readable representation of array. 2: print_r()
         'attributes'    =>    array(
             'rows'          => 60,
             'autofocus'     => null,
@@ -232,13 +232,13 @@ 
             . "<div class='admin-page-framework-input-label-container'>"
                 . "<label for='{$aField[ 'input_id' ]}'>"
                     . $aField[ 'before_input' ]
-                    . ( $aField[ 'label' ] && ! $aField[ 'repeatable' ]
-                        ? "<span " . $this->getLabelContainerAttributes( $aField, 'admin-page-framework-input-label-string' ) . ">"
+                    . ( $aField[ 'label' ] && !$aField[ 'repeatable' ]
+                        ? "<span ".$this->getLabelContainerAttributes( $aField, 'admin-page-framework-input-label-string' ).">"
                                 . $aField[ 'label' ]
                             . "</span>"
                         : ""
                     )
-                    . "<textarea " . $this->getAttributes( $_aInputAttributes ) . " >"
+                    . "<textarea ".$this->getAttributes( $_aInputAttributes )." >"
                         . esc_textarea( $this->_getSystemInfomation( $aField[ 'value' ], $aField[ 'data' ], $aField[ 'print_type' ] ) )
                     . "</textarea>"
                     . $aField[ 'after_input' ]
@@ -253,15 +253,15 @@ 
          * @return      string      The human readable system information.
          * @internal
          */
-        private function _getSystemInfomation( $asValue=null, $asCustomData=null, $iPrintType=1 ) {
+        private function _getSystemInfomation( $asValue = null, $asCustomData = null, $iPrintType = 1 ) {
 
             if ( isset( $asValue ) ) {
                 return $asValue;
             }
 
-            $_aOutput   = array();
-            foreach( $this->_getFormattedSystemInformation( $asCustomData ) as $_sSection => $_aInfo ) {
-                $_aOutput[] = $this->_getSystemInfoBySection( $_sSection, $_aInfo, $iPrintType );
+            $_aOutput = array();
+            foreach ( $this->_getFormattedSystemInformation( $asCustomData ) as $_sSection => $_aInfo ) {
+                $_aOutput[ ] = $this->_getSystemInfoBySection( $_sSection, $_aInfo, $iPrintType );
             }
             return implode( PHP_EOL, $_aOutput );
 
@@ -276,18 +276,18 @@ 
 
                 $_aData = $this->getAsArray( $asCustomData );
                 $_aData = $_aData + array(
-                    'Admin Page Framework'  => isset( $_aData['Admin Page Framework'] )
+                    'Admin Page Framework'  => isset( $_aData[ 'Admin Page Framework' ] )
                         ? null
                         : AdminPageFramework_Registry::getInfo(),
-                    'WordPress'             => $this->_getSiteInfoWithCache( ! isset( $_aData['WordPress'] ) ),
-                    'PHP'                   => $this->_getPHPInfo( ! isset( $_aData['PHP'] ) ),
-                    'PHP Error Log'         => $this->_getErrorLogByType( 'php', ! isset( $_aData['PHP Error Log'] ) ),
-                    'MySQL'                 => isset( $_aData['MySQL'] )
+                    'WordPress'             => $this->_getSiteInfoWithCache( !isset( $_aData[ 'WordPress' ] ) ),
+                    'PHP'                   => $this->_getPHPInfo( !isset( $_aData[ 'PHP' ] ) ),
+                    'PHP Error Log'         => $this->_getErrorLogByType( 'php', !isset( $_aData[ 'PHP Error Log' ] ) ),
+                    'MySQL'                 => isset( $_aData[ 'MySQL' ] )
                         ? null
-                        : $this->getMySQLInfo(),    // defined in the utility class.
-                    'MySQL Error Log'       => $this->_getErrorLogByType( 'mysql', ! isset( $_aData['MySQL Error Log'] ) ),
-                    'Server'                => $this->_getWebServerInfo( ! isset( $_aData['Server'] ) ),
-                    'Browser'               => $this->_getClientInfo( ! isset( $_aData['Browser'] ) ),
+                        : $this->getMySQLInfo(), // defined in the utility class.
+                    'MySQL Error Log'       => $this->_getErrorLogByType( 'mysql', !isset( $_aData[ 'MySQL Error Log' ] ) ),
+                    'Server'                => $this->_getWebServerInfo( !isset( $_aData[ 'Server' ] ) ),
+                    'Browser'               => $this->_getClientInfo( !isset( $_aData[ 'Browser' ] ) ),
                 );
 
                 // Dropping empty elements allows the user to remove a section by setting an empty section.
@@ -304,10 +304,10 @@ 
                 switch ( $iPrintType ) {
                     default:
                     case 1: // use the framework readable representation of arrays.
-                        return $this->getReadableArrayContents( $sSectionName, $aData, 32 ) . PHP_EOL;
+                        return $this->getReadableArrayContents( $sSectionName, $aData, 32 ).PHP_EOL;
                     case 2: // use print_r()
-                        return "[{$sSectionName}]" . PHP_EOL
-                            . print_r( $aData, true ) . PHP_EOL;
+                        return "[{$sSectionName}]".PHP_EOL
+                            . print_r( $aData, true ).PHP_EOL;
                 }
             }
             /**
@@ -317,17 +317,17 @@ 
              * @since       3.4.6
              * @since       3.5.3       Added the $bGenerateInfo paramter. This is to reduce conditional statment in the caller method.
              */
-            private function _getClientInfo( $bGenerateInfo=true ) {
+            private function _getClientInfo( $bGenerateInfo = true ) {
 
-                if ( ! $bGenerateInfo ) {
+                if ( !$bGenerateInfo ) {
                     return '';
                 }
 
                 // Check the browscap value in the ini file first to prevent warnings from being populated
                 $_aBrowser = @ini_get( 'browscap' )
-                    ? get_browser( $_SERVER['HTTP_USER_AGENT'], true )
+                    ? get_browser( $_SERVER[ 'HTTP_USER_AGENT' ], true )
                     : array();
-                unset( $_aBrowser['browser_name_regex'] );  // this element causes output to be blank
+                unset( $_aBrowser[ 'browser_name_regex' ] ); // this element causes output to be blank
                 return empty( $_aBrowser )
                     ? __( 'No browser information found.', 'admin-page-framework' )
                     : $_aBrowser;
@@ -343,9 +343,9 @@ 
              * @param       string      $sType          The error log type. Either 'php' or 'mysql' is accepted.
              * @param       boolean     $bGenerateInfo  Whether to generate a log. This is for the caller method to reduce a conditinal statement.
              */
-            private function _getErrorLogByType( $sType, $bGenerateInfo=true ) {
+            private function _getErrorLogByType( $sType, $bGenerateInfo = true ) {
 
-                if ( ! $bGenerateInfo ) {
+                if ( !$bGenerateInfo ) {
                     return '';
                 }
                 switch ( $sType ) {
@@ -377,9 +377,9 @@ 
              * @since       3.5.3       Added the $bGenerateInfo paramter. This is to reduce conditional statment in the caller method.
              * @return      array      The generated site information array.
              */
-            private function _getSiteInfoWithCache( $bGenerateInfo=true ) {
+            private function _getSiteInfoWithCache( $bGenerateInfo = true ) {
 
-                if ( ! $bGenerateInfo || isset( self::$_aSiteInfo ) ) {
+                if ( !$bGenerateInfo || isset( self::$_aSiteInfo ) ) {
                     return self::$_aSiteInfo;
                 }
                 self::$_aSiteInfo = self::_getSiteInfo();
@@ -413,8 +413,8 @@ 
                         'wp_remote_get()'                                           => $this->_getWPRemoteGetStatus(),
                         __( 'Multibite String Extension', 'admin-page-framework' )  => $this->getAOrB( function_exists( 'mb_detect_encoding' ), $this->oMsg->get( 'enabled' ), $this->oMsg->get( 'disabled' ) ),
                         __( 'WP_CONTENT_DIR Writeable', 'admin-page-framework' )    => $this->getAOrB( is_writable( WP_CONTENT_DIR ), $this->oMsg->get( 'yes' ), $this->oMsg->get( 'no' ) ),
-                        __( 'Active Plugins', 'admin-page-framework' )              => PHP_EOL . $this->_getActivePlugins(),
-                        __( 'Network Active Plugins', 'admin-page-framework' )      => PHP_EOL . $this->_getNetworkActivePlugins(),
+                        __( 'Active Plugins', 'admin-page-framework' )              => PHP_EOL.$this->_getActivePlugins(),
+                        __( 'Network Active Plugins', 'admin-page-framework' )      => PHP_EOL.$this->_getNetworkActivePlugins(),
                         __( 'Constants', 'admin-page-framework' )                   => $this->_getDefinedConstants( 'user' ),
                     );
                 }
@@ -424,9 +424,9 @@ 
                      * @return      string|array
                      * @internal
                      */
-                    private function _getDefinedConstants( $asCategories=null, $asRemovingCategories=null ) {
+                    private function _getDefinedConstants( $asCategories = null, $asRemovingCategories = null ) {
                         $_asConstants = $this->getDefinedConstants( $asCategories, $asRemovingCategories );
-                        if ( ! is_array( $_asConstants ) ) {
+                        if ( !is_array( $_asConstants ) ) {
                             return $_asConstants;
                         }
                         if ( isset( $_asConstants[ 'user' ] ) ) {
@@ -462,13 +462,13 @@ 
                 private function _getActiveThemeName() {
 
                     // If the WordPress version is less than 3.4,
-                    if ( version_compare( $GLOBALS['wp_version'], '3.4', '<' ) ) {
-                        $_aThemeData = get_theme_data( get_stylesheet_directory() . '/style.css' );
-                        return $_aThemeData['Name'] . ' ' . $_aThemeData['Version'];
+                    if ( version_compare( $GLOBALS[ 'wp_version' ], '3.4', '<' ) ) {
+                        $_aThemeData = get_theme_data( get_stylesheet_directory().'/style.css' );
+                        return $_aThemeData[ 'Name' ].' '.$_aThemeData[ 'Version' ];
                     }
 
                     $_oThemeData = wp_get_theme();
-                    return $_oThemeData->Name . ' ' . $_oThemeData->Version;
+                    return $_oThemeData->Name.' '.$_oThemeData->Version;
 
                 }
                 /**
@@ -482,10 +482,10 @@ 
                     $_aPluginList       = array();
                     $_aActivePlugins    = get_option( 'active_plugins', array() );
                     foreach ( get_plugins() as $_sPluginPath => $_aPlugin ) {
-                        if ( ! in_array( $_sPluginPath, $_aActivePlugins ) ) {
+                        if ( !in_array( $_sPluginPath, $_aActivePlugins ) ) {
                             continue;
                         }
-                        $_aPluginList[] = '    ' . $_aPlugin['Name'] . ': ' . $_aPlugin['Version'];
+                        $_aPluginList[ ] = '    '.$_aPlugin[ 'Name' ].': '.$_aPlugin[ 'Version' ];
                     }
                     return implode( PHP_EOL, $_aPluginList );
 
@@ -497,17 +497,17 @@ 
                  */
                 private function _getNetworkActivePlugins() {
 
-                    if ( ! is_multisite() ) {
+                    if ( !is_multisite() ) {
                         return '';
                     }
                     $_aPluginList       = array();
                     $_aActivePlugins    = get_site_option( 'active_sitewide_plugins', array() );
                     foreach ( wp_get_active_network_plugins() as $_sPluginPath ) {
-                        if ( ! array_key_exists( plugin_basename( $_sPluginPath ), $_aActivePlugins ) ) {
+                        if ( !array_key_exists( plugin_basename( $_sPluginPath ), $_aActivePlugins ) ) {
                             continue;
                         }
                         $_aPlugin       = get_plugin_data( $_sPluginPath );
-                        $_aPluginList[] = '    ' . $_aPlugin['Name'] . ' :' . $_aPlugin['Version'];
+                        $_aPluginList[ ] = '    '.$_aPlugin[ 'Name' ].' :'.$_aPlugin[ 'Version' ];
                     }
                     return implode( PHP_EOL, $_aPluginList );
 
@@ -525,7 +525,7 @@ 
                     $_vResponse = false === $_vResponse
                         ? wp_remote_post(
                             // 'https://www.paypal.com/cgi-bin/webscr',
-                            add_query_arg( $_GET, admin_url( $GLOBALS['pagenow'] ) ),
+                            add_query_arg( $_GET, admin_url( $GLOBALS[ 'pagenow' ] ) ),
                             array(
                                 'sslverify'     => false,
                                 'timeout'       => 60,
@@ -548,7 +548,7 @@ 
                     $_vResponse = $this->getTransient( 'apf_rg_check' );
                     $_vResponse = false === $_vResponse
                         ? wp_remote_get(
-                            add_query_arg( $_GET + array( 'apf_remote_request_test' => '_testing' ), admin_url( $GLOBALS['pagenow'] ) ),
+                            add_query_arg( $_GET + array( 'apf_remote_request_test' => '_testing' ), admin_url( $GLOBALS[ 'pagenow' ] ) ),
                             array(
                                 'sslverify'     => false,
                                 'timeout'       => 60,
@@ -573,7 +573,7 @@ 
                         if ( is_wp_error( $mResponse ) ) {
                             return true;
                         }
-                        if ( $mResponse[ 'response'][ 'code' ] < 200 ) {
+                        if ( $mResponse[ 'response' ][ 'code' ] < 200 ) {
                             return true;
                         }
                         if ( $mResponse[ 'response' ][ 'code' ] >= 300 ) {
@@ -596,13 +596,13 @@ 
              * @since       3.4.6
              * @since       3.5.3       Added the $bGenerateInfo parameter. This is to reduce conditional statement in the caller method.
              */
-            private function _getPHPInfo( $bGenerateInfo=true ) {
+            private function _getPHPInfo( $bGenerateInfo = true ) {
 
-                if ( ! $bGenerateInfo || isset( self::$_aPHPInfo ) ) {
+                if ( !$bGenerateInfo || isset( self::$_aPHPInfo ) ) {
                     return self::$_aPHPInfo;
                 }
 
-                $_oErrorReporting   = new AdminPageFramework_ErrorReporting;
+                $_oErrorReporting = new AdminPageFramework_ErrorReporting;
                 self::$_aPHPInfo = array(
                     __( 'Version', 'admin-page-framework' )                 => phpversion(),
                     __( 'Safe Mode', 'admin-page-framework' )               => $this->getAOrB( @ini_get( 'safe_mode' ), $this->oMsg->get( 'yes' ), $this->oMsg->get( 'no' ) ),
@@ -613,16 +613,16 @@ 
                     __( 'Max Execution Time', 'admin-page-framework' )      => @ini_get( 'max_execution_time' ),
                     __( 'Max Input Vars', 'admin-page-framework' )          => @ini_get( 'max_input_vars' ),
                     __( 'Argument Separator', 'admin-page-framework' )      => @ini_get( 'arg_separator.output' ),
-                    __( 'Allow URL File Open', 'admin-page-framework' )     => $this->getAOrB( @ini_get( 'allow_url_fopen' ),    $this->oMsg->get( 'yes' ), $this->oMsg->get( 'no' ) ),
-                    __( 'Display Errors', 'admin-page-framework' )          => $this->getAOrB( @ini_get( 'display_errors' ),     $this->oMsg->get( 'on' ), $this->oMsg->get( 'off' ) ),
-                    __( 'Log Errors', 'admin-page-framework' )              => $this->getAOrB( @ini_get( 'log_errors' ),         $this->oMsg->get( 'on' ), $this->oMsg->get( 'off' ) ),
+                    __( 'Allow URL File Open', 'admin-page-framework' )     => $this->getAOrB( @ini_get( 'allow_url_fopen' ), $this->oMsg->get( 'yes' ), $this->oMsg->get( 'no' ) ),
+                    __( 'Display Errors', 'admin-page-framework' )          => $this->getAOrB( @ini_get( 'display_errors' ), $this->oMsg->get( 'on' ), $this->oMsg->get( 'off' ) ),
+                    __( 'Log Errors', 'admin-page-framework' )              => $this->getAOrB( @ini_get( 'log_errors' ), $this->oMsg->get( 'on' ), $this->oMsg->get( 'off' ) ),
                     __( 'Error log location', 'admin-page-framework' )      => @ini_get( 'error_log' ),
                     __( 'Error Reporting Level', 'admin-page-framework' )   => $_oErrorReporting->getErrorLevel(),
-                    __( 'FSOCKOPEN', 'admin-page-framework' )               => $this->getAOrB( function_exists( 'fsockopen' ),   $this->oMsg->get( 'supported' ), $this->oMsg->get( 'not_supported' ) ),
-                    __( 'cURL', 'admin-page-framework' )                    => $this->getAOrB( function_exists( 'curl_init' ),   $this->oMsg->get( 'supported' ), $this->oMsg->get( 'not_supported' ) ),
-                    __( 'SOAP', 'admin-page-framework' )                    => $this->getAOrB( class_exists( 'SoapClient' ),     $this->oMsg->get( 'supported' ), $this->oMsg->get( 'not_supported' ) ),
-                    __( 'SUHOSIN', 'admin-page-framework' )                 => $this->getAOrB( extension_loaded( 'suhosin' ),    $this->oMsg->get( 'supported' ), $this->oMsg->get( 'not_supported' ) ),
-                    'ini_set()'                                             => $this->getAOrB( function_exists( 'ini_set' ),     $this->oMsg->get( 'supported' ), $this->oMsg->get( 'not_supported' ) ),
+                    __( 'FSOCKOPEN', 'admin-page-framework' )               => $this->getAOrB( function_exists( 'fsockopen' ), $this->oMsg->get( 'supported' ), $this->oMsg->get( 'not_supported' ) ),
+                    __( 'cURL', 'admin-page-framework' )                    => $this->getAOrB( function_exists( 'curl_init' ), $this->oMsg->get( 'supported' ), $this->oMsg->get( 'not_supported' ) ),
+                    __( 'SOAP', 'admin-page-framework' )                    => $this->getAOrB( class_exists( 'SoapClient' ), $this->oMsg->get( 'supported' ), $this->oMsg->get( 'not_supported' ) ),
+                    __( 'SUHOSIN', 'admin-page-framework' )                 => $this->getAOrB( extension_loaded( 'suhosin' ), $this->oMsg->get( 'supported' ), $this->oMsg->get( 'not_supported' ) ),
+                    'ini_set()'                                             => $this->getAOrB( function_exists( 'ini_set' ), $this->oMsg->get( 'supported' ), $this->oMsg->get( 'not_supported' ) ),
                 )
                 + $this->getPHPInfo()
                 + array(
@@ -641,11 +641,11 @@ 
              * @since       3.5.3       Added the $bGenerateInfo paramter. This is to reduce conditional statment in the caller method.
              * @return      array|string
              */
-            private function _getWebServerInfo( $bGenerateInfo=true ) {
+            private function _getWebServerInfo( $bGenerateInfo = true ) {
 
                 return $bGenerateInfo
                     ? array(
-                        __( 'Web Server', 'admin-page-framework' )                  => $_SERVER['SERVER_SOFTWARE'],
+                        __( 'Web Server', 'admin-page-framework' )                  => $_SERVER[ 'SERVER_SOFTWARE' ],
                         'SSL'                                                       => $this->getAOrB( is_ssl(), $this->oMsg->get( 'yes' ), $this->oMsg->get( 'no' ) ),
                         __( 'Session', 'admin-page-framework' )                     => $this->getAOrB( isset( $_SESSION ), $this->oMsg->get( 'enabled' ), $this->oMsg->get( 'disabled' ) ),
                         __( 'Session Name', 'admin-page-framework' )                => esc_html( @ini_get( 'session.name' ) ),

development/factory/_common/form/input/AdminPageFramework_Input_checkbox.php

Doc Comments -2 removed lines

@@ -27,8 +27,6 @@
      * Returns the output of the input element.
      *
      * @since       3.4.0
-     * @param       string      $sLabel         The label text.
-     * @param       array       $aAttributes    (optional) The attribute array. If set, it will be merged with the attribute set in the constructor.
      */
     public function get( /* $sLabel, $aAttributes=array() */ ) {
 

Indentation +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
 
         // Output
         return
-           "<{$this->aOptions[ 'input_container_tag' ]} " . $this->getAttributes( $this->aOptions[ 'input_container_attributes' ] ) . ">"
+            "<{$this->aOptions[ 'input_container_tag' ]} " . $this->getAttributes( $this->aOptions[ 'input_container_attributes' ] ) . ">"
                 . $this->_getInputElements( $_aAttributes, $this->aOptions )
             . "</{$this->aOptions[ 'input_container_tag' ]}>"
             . "<{$this->aOptions[ 'label_container_tag' ]} " . $this->getAttributes( $this->aOptions[ 'label_container_attributes' ] ) . ">"

Spacing +13 added lines, -13 removed lines

@@ -33,11 +33,11 @@ 
     public function get( /* $sLabel, $aAttributes=array() */ ) {
 
         // Parameters
-        $_aParams       = func_get_args() + array(
-            0 => '',            // 1st parameter
+        $_aParams = func_get_args() + array(
+            0 => '', // 1st parameter
             1 => array()        // 2nd parameter
         );
-        $_sLabel        = $_aParams[ 0 ];       // first parameter
+        $_sLabel        = $_aParams[ 0 ]; // first parameter
 
         // Attributes
         $_aAttributes   = $this->uniteArrays(   // second parameter
@@ -47,10 +47,10 @@ 
 
         // Output
         return
-           "<{$this->aOptions[ 'input_container_tag' ]} " . $this->getAttributes( $this->aOptions[ 'input_container_attributes' ] ) . ">"
+           "<{$this->aOptions[ 'input_container_tag' ]} ".$this->getAttributes( $this->aOptions[ 'input_container_attributes' ] ).">"
                 . $this->_getInputElements( $_aAttributes, $this->aOptions )
             . "</{$this->aOptions[ 'input_container_tag' ]}>"
-            . "<{$this->aOptions[ 'label_container_tag' ]} " . $this->getAttributes( $this->aOptions[ 'label_container_attributes' ] ) . ">"
+            . "<{$this->aOptions[ 'label_container_tag' ]} ".$this->getAttributes( $this->aOptions[ 'label_container_attributes' ] ).">"
                 . $_sLabel
             . "</{$this->aOptions[ 'label_container_tag' ]}>"
         ;
@@ -64,16 +64,16 @@ 
         private function _getInputElements( $aAttributes, $aOptions ) {
             $_sOutput = $this->aOptions[ 'save_unchecked' ]
                 // the unchecked value must be set prior to the checkbox input field.
-                ? "<input " . $this->getAttributes(
+                ? "<input ".$this->getAttributes(
                     array(
                         'type'      => 'hidden',
                         'class'     => $aAttributes[ 'class' ],
                         'name'      => $aAttributes[ 'name' ],
                         'value'     => '0',
                     )
-                ) . " />"
+                )." />"
                 : '';
-            $_sOutput .= "<input " . $this->getAttributes( $aAttributes ) . " />";
+            $_sOutput .= "<input ".$this->getAttributes( $aAttributes )." />";
             return $_sOutput;
         }
 
@@ -86,7 +86,7 @@ 
     public function getAttributesByKey( /* $sKey */ ) {
 
         // Parameters
-        $_aParams       = func_get_args() + array( 0 => '', );
+        $_aParams       = func_get_args() + array( 0 => '',);
         $_sKey          = $_aParams[ 0 ];
         $_bIsMultiple   = '' !== $_sKey;
 
@@ -98,13 +98,13 @@ 
             // The type needs to be specified since the postytpe field type extends this class. If not set, the 'posttype' will be passed to the type attribute.
             + array(
                 'type'      => 'checkbox',
-                'id'        => $this->aAttributes[ 'id' ] . '_' . $_sKey,
+                'id'        => $this->aAttributes[ 'id' ].'_'.$_sKey,
                 'checked'   => $this->_getCheckedAttributeValue( $_sKey ),
-                'value'     => 1,   // this must be always 1 because the key value can be zero. In that case, the value always will be false and unchecked.
+                'value'     => 1, // this must be always 1 because the key value can be zero. In that case, the value always will be false and unchecked.
                 'name'      => $_bIsMultiple
                     ? "{$this->aAttributes[ 'name' ]}[{$_sKey}]"
                     : $this->aAttributes[ 'name' ],
-                'data-id'   => $this->aAttributes[ 'id' ],       // referenced by the JavaScript scripts such as the revealer script.
+                'data-id'   => $this->aAttributes[ 'id' ], // referenced by the JavaScript scripts such as the revealer script.
             )
             + $this->aAttributes
             ;
@@ -121,7 +121,7 @@ 
                 : array( 'value', $_sKey );
             return $this->getElement( $this->aAttributes, $_aValueDimension )
                 ? 'checked'
-                : null;    // to not to set, pass null. An empty value '' will still set the attribute.
+                : null; // to not to set, pass null. An empty value '' will still set the attribute.
 
         }
 

development/factory/_common/form/input/AdminPageFramework_Input_select.php

Doc Comments +3 added lines, -1 removed lines

@@ -121,7 +121,7 @@ 
          * @internal
          * @param       string      $sInputID           The input ID that will be the base of each generated option tag ID.
          * @param       array       $aLabels            The array holding labels.
-         * @param       array       $aAttributes        The attribute arrays. Accepts the following arguments.
+         * @param       array       $aBaseAttributes        The attribute arrays. Accepts the following arguments.
          * - optgroup
          * - option
          */
@@ -159,6 +159,7 @@ 
             /**
              * Returns an HTML output of optgroup tag.
              * @since       3.5.3
+             * @param string $sInputID
              * @return      string      an HTML output of optgroup tag.
              */
             private function _getOptGroup( array $aBaseAttributes, $sInputID, $sKey, $asLabel ) {
@@ -178,6 +179,7 @@ 
             /**
              *
              * @since        3.5.3
+             * @param string $sInputID
              */
             private function _getOptionTagAttributes( array $aBaseAttributes, $sInputID, $sKey, $aValues ) {
 

Spacing +14 added lines, -14 removed lines

@@ -68,14 +68,14 @@ 
         );
 
         return
-            "<{$this->aOptions[ 'input_container_tag' ]} " . $this->getAttributes( $this->aOptions[ 'input_container_attributes' ] ) . ">"
-                . "<select " . $this->getAttributes( $this->_getSelectAttributes( $_aAttributes ) ) . " >"
+            "<{$this->aOptions[ 'input_container_tag' ]} ".$this->getAttributes( $this->aOptions[ 'input_container_attributes' ] ).">"
+                . "<select ".$this->getAttributes( $this->_getSelectAttributes( $_aAttributes ) )." >"
                     . $this->_getDropDownList(
                         $this->getAttribute( 'id' ),
                         $this->getAsArray(
                             isset( $_aLabels )
                                 ? $_aLabels
-                                : $this->aField[ 'label' ],    // backward compatibility
+                                : $this->aField[ 'label' ], // backward compatibility
                             true
                         ),
                         $_aAttributes
@@ -103,9 +103,9 @@ 
                         ? 'multiple'
                         : null,
                     'name'      => $_bIsMultiple
-                        ? $this->getAttribute( 'name' ) . '[]'
+                        ? $this->getAttribute( 'name' ).'[]'
                         : $this->getAttribute( 'name' ),
-                    'data-id'   => $this->getAttribute( 'id' ),       // referenced by the JavaScript scripts such as the revealer script.
+                    'data-id'   => $this->getAttribute( 'id' ), // referenced by the JavaScript scripts such as the revealer script.
                 )
             );
 
@@ -127,12 +127,12 @@ 
          */
         private function _getDropDownList( $sInputID, array $aLabels, array $aBaseAttributes ) {
 
-            $_aOutput   = array();
-            foreach( $aLabels as $__sKey => $__asLabel ) {
+            $_aOutput = array();
+            foreach ( $aLabels as $__sKey => $__asLabel ) {
 
                 // For an optgroup tag,
                 if ( is_array( $__asLabel ) ) {
-                    $_aOutput[] = $this->_getOptGroup(
+                    $_aOutput[ ] = $this->_getOptGroup(
                         $aBaseAttributes,
                         $sInputID,
                         $__sKey,
@@ -142,8 +142,8 @@ 
                 }
 
                 // A normal option tag,
-                $_aOutput[] = $this->_getOptionTag(
-                    $__asLabel,   // the text label the user sees to be selected
+                $_aOutput[ ] = $this->_getOptionTag(
+                    $__asLabel, // the text label the user sees to be selected
                     $this->_getOptionTagAttributes(
                         $aBaseAttributes,
                         $sInputID,
@@ -169,7 +169,7 @@ 
                 $_aOptGroupAttributes = array(
                     'label' => $sKey,
                 ) + $_aOptGroupAttributes;
-                return "<optgroup " . $this->getAttributes( $_aOptGroupAttributes ) . ">"
+                return "<optgroup ".$this->getAttributes( $_aOptGroupAttributes ).">"
                         . $this->_getDropDownList( $sInputID, $asLabel, $aBaseAttributes )
                     . "</optgroup>";
 
@@ -187,7 +187,7 @@ 
                     $aValues
                 );
                 return array(
-                        'id'        => $sInputID . '_' . $sKey,
+                        'id'        => $sInputID.'_'.$sKey,
                         'value'     => $sKey,
                         'selected'  => in_array( ( string ) $sKey, $aValues )
                             ? 'selected'
@@ -203,8 +203,8 @@ 
              * @sicne       3.4.0
              * @return      string      The generated option tag HTML output.
              */
-            private function _getOptionTag( $sLabel, array $aOptionTagAttributes=array() ) {
-                return "<option " . $this->getAttributes( $aOptionTagAttributes ) . " >"
+            private function _getOptionTag( $sLabel, array $aOptionTagAttributes = array() ) {
+                return "<option ".$this->getAttributes( $aOptionTagAttributes )." >"
                         . $sLabel
                     . "</option>";
             }

development/factory/_common/utility/AdminPageFramework_ArrayHandler.php

Doc Comments -14 removed lines

@@ -83,12 +83,6 @@ 
      * Returns the specified option value.
      *
      * @since       3.6.0
-     * @param       string|array        $sKey1|$aKeys       The dimensional key or keys of an array of the element to extract its value.
-     * If a string is set to the first parameter, the second parameter is also expected to be a string serving as a second dimensional key.
-     * For example, there is a multi-dimensional array, `array( 'a' => array( 'b' => 'bbb' ) )` to extract the value of the 'b' element in the second depth,
-     * set the parameter as follows. `get( 'a', 'b' )` or `get( array( 'a', 'b' ) );`
-     * @param       string|variant      $sKey2|$vDefault    The second dimensional key or the default value in case the value is not set.
-     * @param       string              $sKey3              The third dimensional key and so on.
      */
     public function get( /* $sKey1, $sKey2, $sKey3, ... OR $aKeys, $vDefault */ ) {
 
@@ -138,10 +132,6 @@ 
      *
      * @since       3.6.0
      * @return      void
-     * @param       string|array        $asKeys       The key or keys of an array of the element to set its value.
-     * If a string is passed, it specifies the element with the set key. If an array is passed, it specifies the element with the dimensional keys.
-     * For example, `set( 'a', 'aaa' )` will set a value, `array( 'a' => 'aaa' )` and `set( array( 'a', 'b' ), 'bbb' )` will set `array( 'a' => array( 'b' => 'bbb' ) )`.
-     * @param       variant             $mValue       The value to be set.
      */
     public function set( /* $asKeys, $mValue */ ) {
 
@@ -167,10 +157,6 @@ 
      * Removes an element by dimensional keys.
      * @since       3.6.0
      * @return      void
-     * @param       string|array        $asKeys       The key or keys of an array of the element to set its value.
-     * If a string is passed, it specifies the element with the set key. If an array is passed, it specifies the element with the dimensional keys.
-     * For example, `delete( 'a' )` will unset an element of `a` in `array( 'a' => 'some value' )` so it becomes `array()`.
-     * `delete( array( 'a', 'b' ) )` will unset the element of `b` in `array( 'a' => array( 'b' => 'bbb' ) )`.
      */
     public function delete( /* $sKey1, $sKey2, $sKey3 ... OR $aKeys */ ) {
 

Spacing +9 added lines, -9 removed lines

@@ -51,14 +51,14 @@ 
      * @since       3.6.0
      * @var         array
      */
-    public $aData            = array();
+    public $aData = array();
 
     /**
      * Stores the default values.
      * @since       3.6.0
      * @var         array
      */
-    public $aDefault         = array();
+    public $aDefault = array();
     /**#@-*/
 
     /**
@@ -96,7 +96,7 @@ 
         $_aKeys     = func_get_args() + array( null );
 
         // If no key is specified, return the whole array.
-        if ( ! isset( $_aKeys[ 0 ] ) ) {
+        if ( !isset( $_aKeys[ 0 ] ) ) {
             return $this->uniteArrays(
                 $this->aData,
                 $this->aDefault
@@ -111,8 +111,8 @@ 
 
         // Now either the section ID or field ID is given.
         return $this->getArrayValueByArrayKeys(
-            $this->aData,   // subject array
-            $_aKeys,        // dimensional keys
+            $this->aData, // subject array
+            $_aKeys, // dimensional keys
             $this->_getDefaultValue( // default value
                 $_mDefault,
                 $_aKeys
@@ -145,8 +145,8 @@ 
      */
     public function set( /* $asKeys, $mValue */ ) {
 
-        $_aParameters   = func_get_args();
-        if ( ! isset( $_aParameters[ 0 ], $_aParameters[ 1 ] ) ) {
+        $_aParameters = func_get_args();
+        if ( !isset( $_aParameters[ 0 ], $_aParameters[ 1 ] ) ) {
             return;
         }
         $_asKeys        = $_aParameters[ 0 ];
@@ -174,8 +174,8 @@ 
      */
     public function delete( /* $sKey1, $sKey2, $sKey3 ... OR $aKeys */ ) {
 
-        $_aParameters   = func_get_args();
-        if ( ! isset( $_aParameters[ 0 ], $_aParameters[ 1 ] ) ) {
+        $_aParameters = func_get_args();
+        if ( !isset( $_aParameters[ 0 ], $_aParameters[ 1 ] ) ) {
             return;
         }
         $_asKeys        = $_aParameters[ 0 ];

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

Doc Comments +2 added lines

@@ -22,6 +22,7 @@ 
      *
      * @since       2.0.0
      * @since       3.5.7       Moved from `AdminPageFramework_Utility`.
+     * @param string $sQueryKey
      * @return      string|null
      */
     static public function getQueryValueInURLByKey( $sURL, $sQueryKey ) {
@@ -71,6 +72,7 @@ 
         /**
          * Returns the port suffix in the currently loading url.
          * @since       3.5.7
+         * @param boolean $_bSSL
          * @return      string
          */
         static private function _getURLPortSuffix( $_bSSL ) {

Spacing +4 added lines, -4 removed lines

@@ -51,7 +51,7 @@ 
             0 => '',
             1 => 's',
         );
-        $_sProtocol         = substr( $_sServerProtocol, 0, strpos( $_sServerProtocol, '/' ) )
+        $_sProtocol = substr( $_sServerProtocol, 0, strpos( $_sServerProtocol, '/' ) )
             . $_aProrocolSuffix[ ( int ) $_bSSL ];
 
         // Port: e.g. :80
@@ -65,7 +65,7 @@ 
                 : $_SERVER[ 'SERVER_NAME' ]
             );
 
-        return $_sProtocol . '://' . $_sHost . $_sPort . $_SERVER[ 'REQUEST_URI' ];
+        return $_sProtocol.'://'.$_sHost.$_sPort.$_SERVER[ 'REQUEST_URI' ];
 
     }
         /**
@@ -78,10 +78,10 @@ 
                 ? ( string ) $_SERVER[ 'SERVER_PORT' ]
                 : '';
             $_aPort     = array(
-                0 => ':' . $_sPort,
+                0 => ':'.$_sPort,
                 1 => '',
             );
-            $_bPortSet  = ( ! $_bSSL && '80' === $_sPort ) || ( $_bSSL && '443' === $_sPort );
+            $_bPortSet = ( !$_bSSL && '80' === $_sPort ) || ( $_bSSL && '443' === $_sPort );
             return $_aPort[ ( int ) $_bPortSet ];
         }
 

development/factory/_common/utility/wp_utility/AdminPageFramework_WPUtility_Hook.php

Doc Comments +1 added lines, -9 removed lines

@@ -88,11 +88,6 @@ 
      * @access      public
      * @since       2.0.0
      * @remark      Accepts variadic parameters.
-     * @param       object      $oCallerObject      the object that holds the callback method that matches the action hook name.
-     * @param       array       $aActionHooks       a numerically index array consisting of action hook names that serve as the callback method names.
-     * @param       mixed       $vArgs1             the argument to pass to the hook callback functions.
-     * @param       mixed       $vArgs2             another argument to pass to the hook callback functions.
-     * @param       mixed       $_and_more          add as many arguments as necessary to the next parameters.
      * @return      void
      */
     static public function addAndDoActions( /* $oCallerObject, $aActionHooks, $vArgs1=null, $vArgs2=null, $_and_more=null */ ) {
@@ -191,10 +186,6 @@ 
      * `
      *
      * @since       2.0.0
-     * @param       object      $oCallerObject
-     * @param       string      $sFilter            The filter hook name.
-     * @param       mixed       $vData              The filtering data
-     * @param       mixed       $vArgs              The arguments.
      */
     static public function addAndApplyFilter( /* $oCallerObject, $sFilter, $vData, $vArgs... */ ) {
 
@@ -232,6 +223,7 @@ 
      *
      * @since       2.0.0
      * @access      public
+     * @param string $sPrefix
      * @return      array       Returns an array consisting of the filters.
      */
     static public function getFilterArrayByPrefix( $sPrefix, $sClassName, $sPageSlug, $sTabSlug, $bReverse=false ) {

Spacing +17 added lines, -17 removed lines

@@ -25,7 +25,7 @@ 
      * @since       3.4.2
      * @todo        Create a similar function for filters.
      */
-    static public function registerAction( $sActionHook, $oCallable, $iPriority=10 ) {
+    static public function registerAction( $sActionHook, $oCallable, $iPriority = 10 ) {
 
         if ( did_action( $sActionHook ) ) {
             return call_user_func_array( $oCallable, array() );
@@ -62,13 +62,13 @@ 
      * @param       mixed       $_and_more      add as many arguments as necessary to the next parameters.
      * @return      void        does not return a value.
      */
-    static public function doActions( $aActionHooks, $vArgs1=null, $vArgs2=null, $_and_more=null ) {
+    static public function doActions( $aActionHooks, $vArgs1 = null, $vArgs2 = null, $_and_more = null ) {
 
         $aArgs          = func_get_args();
         $aActionHooks   = $aArgs[ 0 ];
-        foreach( ( array ) $aActionHooks as $sActionHook  ) {
+        foreach ( ( array ) $aActionHooks as $sActionHook ) {
             $aArgs[ 0 ] = $sActionHook;
-            call_user_func_array( 'do_action' , $aArgs );
+            call_user_func_array( 'do_action', $aArgs );
         }
 
     }
@@ -100,12 +100,12 @@ 
         $aArgs          = func_get_args();
         $oCallerObject  = $aArgs[ 0 ];
         $aActionHooks   = $aArgs[ 1 ];
-        foreach( ( array ) $aActionHooks as $sActionHook ) {
-            if ( ! $sActionHook ) {
+        foreach ( ( array ) $aActionHooks as $sActionHook ) {
+            if ( !$sActionHook ) {
                 continue;
             }
             $aArgs[ 1 ] = $sActionHook;
-            call_user_func_array( array( get_class(), 'addAndDoAction' ) , $aArgs );
+            call_user_func_array( array( get_class(), 'addAndDoAction' ), $aArgs );
         }
 
     }
@@ -124,7 +124,7 @@ 
         $_aArgs          = func_get_args();
         $_oCallerObject  = $_aArgs[ 0 ];
         $_sActionHook    = $_aArgs[ 1 ];
-        if ( ! $_sActionHook ) {
+        if ( !$_sActionHook ) {
             return;
         }
 
@@ -136,7 +136,7 @@ 
 
         // Remove the first element, the caller object.
         array_shift( $_aArgs );
-        call_user_func_array( 'do_action' , $_aArgs );
+        call_user_func_array( 'do_action', $_aArgs );
 
     }
 
@@ -164,12 +164,12 @@ 
         $_aFilters      = $_aArgs[ 1 ];
         $_vInput        = $_aArgs[ 2 ];
 
-        foreach( ( array ) $_aFilters as $_sFilter ) {
-            if ( ! $_sFilter ) {
+        foreach ( ( array ) $_aFilters as $_sFilter ) {
+            if ( !$_sFilter ) {
                 continue;
             }
             $_aArgs[ 1 ] = $_sFilter;
-            $_aArgs[ 2 ] = $_vInput;    // assigns the updated value as it is filtered in previous iterations
+            $_aArgs[ 2 ] = $_vInput; // assigns the updated value as it is filtered in previous iterations
             $_vInput = call_user_func_array(
                 array( get_class(), 'addAndApplyFilter' ),
                 $_aArgs
@@ -203,7 +203,7 @@ 
         $_aArgs          = func_get_args();
         $_oCallerObject  = $_aArgs[ 0 ];
         $_sFilter        = $_aArgs[ 1 ];
-        if ( ! $_sFilter ) {
+        if ( !$_sFilter ) {
             return $_aArgs[ 2 ];
         }
 
@@ -234,17 +234,17 @@ 
      * @access      public
      * @return      array       Returns an array consisting of the filters.
      */
-    static public function getFilterArrayByPrefix( $sPrefix, $sClassName, $sPageSlug, $sTabSlug, $bReverse=false ) {
+    static public function getFilterArrayByPrefix( $sPrefix, $sClassName, $sPageSlug, $sTabSlug, $bReverse = false ) {
 
         $_aFilters = array();
         if ( $sTabSlug && $sPageSlug ) {
-            $_aFilters[] = "{$sPrefix}{$sPageSlug}_{$sTabSlug}";
+            $_aFilters[ ] = "{$sPrefix}{$sPageSlug}_{$sTabSlug}";
         }
         if ( $sPageSlug ) {
-            $_aFilters[] = "{$sPrefix}{$sPageSlug}";
+            $_aFilters[ ] = "{$sPrefix}{$sPageSlug}";
         }
         if ( $sClassName ) {
-            $_aFilters[] = "{$sPrefix}{$sClassName}";
+            $_aFilters[ ] = "{$sPrefix}{$sClassName}";
         }
         return $bReverse
             ? array_reverse( $_aFilters )

development/factory/admin_page/_model/delegate/validaor/AdminPageFramework_Model__FormSubmission__Validator__Import.php

Doc Comments +4 added lines

@@ -142,6 +142,7 @@ 
                 /**
                  * Sets update admin notice.
                  * @since       3.5.3
+                 * @param boolean $bEmpty
                  * @return      void
                  */
                 private function _setImportAdminNotice( $bEmpty ) {
@@ -209,6 +210,8 @@ 
                  * @since       3.5.3
                  * @since       3.6.3       Moved from `AdminPageFramework_Form_Model_Import`.
                  * @internal
+                 * @param string $sFormatType
+                 * @param string $sImportOptionKey
                  * @return      string      The filtered import data.
                  */
                 private function _getFilteredImportData( array $aArguments, $mData, $aStoredOptions, $sFormatType, $sImportOptionKey ) {
@@ -237,6 +240,7 @@ 
      * @param       string      The filter prefix.
      * @param       mixed       The subject filtering value.
      * @param       array       An argument array holding submit information. Part of this will be passed to the filter callbacks but this itself does not mean is for the filter callbacks.
+     * @param string $sPrefix
      */
     protected function _getFilteredItemForPortByPrefix( $sPrefix, $mFilteringValue, array $aArguments ) {
         return $this->addAndApplyFilters(

Spacing +13 added lines, -13 removed lines

@@ -31,7 +31,7 @@ 
      * @callback    action      try_validation_after_{class name}
      */
     public function _replyToCallback( $aInputs, $aRawInputs, array $aSubmits, $aSubmitInformation, $oFactory ) {
-        if ( ! $this->_shouldProceed() ) {
+        if ( !$this->_shouldProceed() ) {
             return;
         }
         $this->_doImportOptions(
@@ -101,9 +101,9 @@ 
                 // Check the uploaded file MIME type.
                 $_aMIMEType = $this->_getImportMIMEType( $_aArguments );
                 $_sType     = $_oImport->getType();
-                if ( ! in_array( $_sType, $_aMIMEType ) ) {
+                if ( !in_array( $_sType, $_aMIMEType ) ) {
                     $this->oFactory->setSettingNotice( sprintf( $this->oFactory->oMsg->get( 'uploaded_file_type_not_supported' ), $_sType ) );
-                    return $aStoredOptions;        // do not change the framework's options.
+                    return $aStoredOptions; // do not change the framework's options.
                 }
 
                 // Retrieve the importing data.
@@ -168,9 +168,9 @@ 
                         array(
                             'text/plain',
                             'application/octet-stream', // .json file is dealt as a binary file.
-                            'application/json',         // 3.7.0+ some servers cannot upload json files without this
-                            'text/html',                // 3.7.2+
-                            'application/txt',          // 3.7.2+
+                            'application/json', // 3.7.0+ some servers cannot upload json files without this
+                            'text/html', // 3.7.2+
+                            'application/txt', // 3.7.2+
                         ),
                         $aArguments
                     );
@@ -259,18 +259,18 @@ 
     protected function _getPortFilterHookNames( $sPrefix, array $aArguments ) {
 
         return array(
-            $sPrefix . $aArguments[ 'class_name' ] . '_' . $aArguments[ 'pressed_input_id' ],
+            $sPrefix.$aArguments[ 'class_name' ].'_'.$aArguments[ 'pressed_input_id' ],
             $aArguments[ 'section_id' ]
-                ? $sPrefix . $aArguments[ 'class_name' ] . '_' . $aArguments[ 'section_id' ] .'_' . $aArguments[ 'pressed_field_id' ]
-                : $sPrefix . $aArguments[ 'class_name' ] . '_' . $aArguments[ 'pressed_field_id' ],
+                ? $sPrefix.$aArguments[ 'class_name' ].'_'.$aArguments[ 'section_id' ].'_'.$aArguments[ 'pressed_field_id' ]
+                : $sPrefix.$aArguments[ 'class_name' ].'_'.$aArguments[ 'pressed_field_id' ],
             $aArguments[ 'section_id' ]
-                ? $sPrefix . $aArguments[ 'class_name' ] . '_' . $aArguments[ 'section_id' ]
+                ? $sPrefix.$aArguments[ 'class_name' ].'_'.$aArguments[ 'section_id' ]
                 : null,
             $aArguments[ 'tab_slug' ]
-                ? $sPrefix . $aArguments[ 'page_slug' ] . '_' . $aArguments[ 'tab_slug' ]
+                ? $sPrefix.$aArguments[ 'page_slug' ].'_'.$aArguments[ 'tab_slug' ]
                 : null,
-            $sPrefix . $aArguments[ 'page_slug' ],
-            $sPrefix . $aArguments[ 'class_name' ]
+            $sPrefix.$aArguments[ 'page_slug' ],
+            $sPrefix.$aArguments[ 'class_name' ]
         );
 
     }