michaeluno / admin-page-framework

development/factory/_common/form/_view/script/AdminPageFramework_Form_View___Script_RepeatableSection.php

Doc Comments +2 added lines, -2 removed lines

@@ -513,7 +513,7 @@ 
             return self::getAttributes( $_aAttriubtes ) . ' ' . self::getDataAttributes( $aArguments );
         }
         /**
-         * @return  array
+         * @return  string
          * @sicne   3.8.13
          */
         static private function ___getRemoveButtonAttributes( $sContainerTagID, $oMsg, $iSectionCount ) {
@@ -532,7 +532,7 @@ 
 
         /**
          * @since       3.8.13
-         * @return array
+         * @return string
          */
         static private function ___getAddButtonAttributes( $sContainerTagID, $oMsg, $aArguments ) {
             return self::getAttributes(

Indentation +1 added lines, -1 removed lines

@@ -520,7 +520,7 @@
             return self::getAttributes(
                     array(
                     'class'     => 'repeatable-section-remove-button button-secondary '
-                                   . 'repeatable-section-button button button-large',
+                                    . 'repeatable-section-button button button-large',
                     'title'     => $oMsg->get( 'remove_section' ),
                     'style'     => $iSectionCount <= 1
                         ? 'display:none'

Spacing +12 added lines, -12 removed lines

@@ -440,7 +440,7 @@ 
         if ( empty( $asArguments ) ) {
             return '';
         }
-        if ( self::hasBeenCalled( 'repeatable_section_' . $sContainerTagID ) ) {
+        if ( self::hasBeenCalled( 'repeatable_section_'.$sContainerTagID ) ) {
             return '';
         }
 
@@ -448,16 +448,16 @@ 
         $_oFormatter    = new AdminPageFramework_Form_Model___Format_RepeatableSection( $asArguments, $oMsg );
         $_aArguments    = $_oFormatter->get();
         $_sButtons      = "<div class='admin-page-framework-repeatable-section-buttons-outer-container'>"
-                . "<div " . self::___getContainerAttributes( $_aArguments, $oMsg ) . ' >'
-                    . "<a " . self::___getRemoveButtonAttributes( $sContainerTagID, $oMsg, $iSectionCount ) . ">-</a>"
-                    . "<a " . self::___getAddButtonAttributes( $sContainerTagID, $oMsg, $_aArguments ) . ">+</a>"
+                . "<div ".self::___getContainerAttributes( $_aArguments, $oMsg ).' >'
+                    . "<a ".self::___getRemoveButtonAttributes( $sContainerTagID, $oMsg, $iSectionCount ).">-</a>"
+                    . "<a ".self::___getAddButtonAttributes( $sContainerTagID, $oMsg, $_aArguments ).">+</a>"
                 . "</div>"
             . "</div>"
             . AdminPageFramework_Form_Utility::getModalForDisabledRepeatableElement(
-                'repeatable_section_disabled_' . $sContainerTagID,
+                'repeatable_section_disabled_'.$sContainerTagID,
                 $_aArguments[ 'disabled' ]
             );
-        $_sButtonsHTML  = '"' . $_sButtons . '"';
+        $_sButtonsHTML  = '"'.$_sButtons.'"';
         $_aJSArray      = json_encode( $_aArguments );
         $_sScript       = <<<JAVASCRIPTS
 jQuery( document ).ready( function() {
@@ -504,12 +504,12 @@ 
                     empty( $aArguments[ 'disabled' ] ) ? '' : 'disabled'
                 ),
             );
-            unset( $aArguments[ 'disabled' ][ 'message' ] );    // this element can contain HTML tags.
+            unset( $aArguments[ 'disabled' ][ 'message' ] ); // this element can contain HTML tags.
             // Needs to remove it if it is empty as its data attribute will be checked in the JavaScript script.
             if ( empty( $aArguments[ 'disabled' ] ) ) {
                 unset( $aArguments[ 'disabled' ] );
             }
-            return self::getAttributes( $_aAttriubtes ) . ' ' . self::getDataAttributes( $aArguments );
+            return self::getAttributes( $_aAttriubtes ).' '.self::getDataAttributes( $aArguments );
         }
         /**
          * @return  array
@@ -540,10 +540,10 @@ 
                         . 'repeatable-section-button button button-large',
                     'title'     => $oMsg->get( 'add_section' ),
                     'data-id'   => $sContainerTagID,
-                    'href'      => ! empty( $aArguments[ 'disabled' ] )
-                        ? '#TB_inline?width=' . $aArguments[ 'disabled' ][ 'box_width' ]
-                            . '&height=' . $aArguments[ 'disabled' ][ 'box_height' ]
-                            . '&inlineId=' . 'repeatable_section_disabled_' . $sContainerTagID
+                    'href'      => !empty( $aArguments[ 'disabled' ] )
+                        ? '#TB_inline?width='.$aArguments[ 'disabled' ][ 'box_width' ]
+                            . '&height='.$aArguments[ 'disabled' ][ 'box_height' ]
+                            . '&inlineId='.'repeatable_section_disabled_'.$sContainerTagID
                         : null,
                 )
             );

development/factory/_common/form/_model/formatter/AdminPageFramework_Form_Model___Format_RepeatableSection.php

Spacing +5 added lines, -5 removed lines

@@ -36,8 +36,8 @@ 
      * @since   3.8.13
      */
     static protected $_aStructure_Disabled = array(
-        'message'    => 'The ability of repeating sections is disabled.',   // will be reassigned
-        'caption'    => 'Warning',  // will be reassigned
+        'message'    => 'The ability of repeating sections is disabled.', // will be reassigned
+        'caption'    => 'Warning', // will be reassigned
         'box_width'  => 300,
         'box_height' => 72,
     );
@@ -54,7 +54,7 @@ 
      */
     public function __construct( /* array $asArguments, $oMsg */ ) {
 
-        $_aParameters       = func_get_args() + array(
+        $_aParameters = func_get_args() + array(
             $this->_aArguments,
             null
         );
@@ -73,8 +73,8 @@ 
     public function get() {
 
         $_aArguments = $this->_aArguments + self::$_aStructure;
-        unset( $_aArguments[ 0 ] );   // remove the 0 index element converted from `'repeatable   => 'true',`.
-        if ( ! empty( $_aArguments[ 'disabled' ] ) ) {
+        unset( $_aArguments[ 0 ] ); // remove the 0 index element converted from `'repeatable   => 'true',`.
+        if ( !empty( $_aArguments[ 'disabled' ] ) ) {
             $_aArguments[ 'disabled' ] = $_aArguments[ 'disabled' ] + array(
                 'message'    => $this->_getDefaultMessage(),
                 'caption'    => $this->_oMsg->get( 'warning_caption' ),

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

Spacing +26 added lines, -26 removed lines

@@ -59,7 +59,7 @@ 
         'after_label'       => null,    
         'before_field'      => null,
         'after_field'       => null,
-        'label_min_width'   => '',   // (string|integer) min-width applied to the input label in pixels. 3.8.0+ Changed the default value from 140 to 0 as it is now applied via embedded CSS. When this value is set by the user, it is set inline and the value will be overridden. [3.8.4+] Changed the value from `0`  to `''`.
+        'label_min_width'   => '', // (string|integer) min-width applied to the input label in pixels. 3.8.0+ Changed the default value from 140 to 0 as it is now applied via embedded CSS. When this value is set by the user, it is set inline and the value will be overridden. [3.8.4+] Changed the value from `0`  to `''`.
         'before_fieldset'   => null, // 3.1.1+
         'after_fieldset'    => null, // 3.1.1+
         
@@ -99,7 +99,7 @@ 
      * @param       object              $oMsg                   The framework message object.
      * @param       boolean             $bAutoRegister          Whether or not to register the field type(s).
      */
-    public function __construct( $asClassName='admin_page_framework', $asFieldTypeSlug=null, $oMsg=null, $bAutoRegister=true ) {
+    public function __construct( $asClassName = 'admin_page_framework', $asFieldTypeSlug = null, $oMsg = null, $bAutoRegister = true ) {
             
         $this->aFieldTypeSlugs  = empty( $asFieldTypeSlug ) 
             ? $this->aFieldTypeSlugs 
@@ -110,9 +110,9 @@ 
         
         // This automatically registers the field type. The build-in ones will be registered manually so it will be skipped.
         if ( $bAutoRegister ) {
-            foreach( ( array ) $asClassName as $_sClassName ) {
+            foreach ( ( array ) $asClassName as $_sClassName ) {
                 add_filter( 
-                    'field_types_' . $_sClassName, 
+                    'field_types_'.$_sClassName, 
                     array( $this, '_replyToRegisterInputFieldType' )
                 );
             }
@@ -158,8 +158,8 @@ 
         }
         return is_array( $asLabel ) // if the user sets multiple items
             ? $this->getElement( 
-                $asElement,         // subject
-                $this->getAsArray( $asKey, true /* preserve empty */ ),     // dimensional path 
+                $asElement, // subject
+                $this->getAsArray( $asKey, true /* preserve empty */ ), // dimensional path 
                 ''                  // default - if the element is not found, return an empty
             )
             : $asElement;
@@ -174,7 +174,7 @@ 
      */
     protected function getFieldOutput( array $aFieldset ) {
         
-        if ( ! is_object( $aFieldset[ '_caller_object' ] ) ) {
+        if ( !is_object( $aFieldset[ '_caller_object' ] ) ) {
             return '';
         }
 
@@ -182,14 +182,14 @@ 
         $aFieldset[ '_parent_field_object' ] = $aFieldset[ '_field_object' ]; // 3.6.0+
         
         // 3.7.0+ The caller object is no longer a factory object but a form object.
-        $_oCallerForm   = $aFieldset[ '_caller_object' ];
+        $_oCallerForm = $aFieldset[ '_caller_object' ];
 
         $_oFieldset = new AdminPageFramework_Form_View___Fieldset( 
-            $aFieldset,                          // the field definition array
-            $_oCallerForm->aSavedData,               // the stored form data
-            $_oCallerForm->getFieldErrors(),         // the field error array.
-            $_oCallerForm->aFieldTypeDefinitions,    // the field type definition array.
-            $_oCallerForm->oMsg,                     // the system message object
+            $aFieldset, // the field definition array
+            $_oCallerForm->aSavedData, // the stored form data
+            $_oCallerForm->getFieldErrors(), // the field error array.
+            $_oCallerForm->aFieldTypeDefinitions, // the field type definition array.
+            $_oCallerForm->oMsg, // the system message object
             $_oCallerForm->aCallbacks                // field output element callables.
         );           
         return $_oFieldset->get();
@@ -229,13 +229,13 @@ 
      * @since       3.0.3       Tweaked it to have better execution speed.
      * @internal
      */
-    public function getDefinitionArray( $sFieldTypeSlug='' ) {
+    public function getDefinitionArray( $sFieldTypeSlug = '' ) {
         
         // The uniteArrays() method resulted in somewhat being slow due to overhead on checking array keys for recursive array merges.
         $_aDefaultKeys = $this->aDefaultKeys + self::$_aDefaultKeys;
-        $_aDefaultKeys['attributes'] = isset( $this->aDefaultKeys['attributes'] ) && is_array( $this->aDefaultKeys['attributes'] )
-            ? $this->aDefaultKeys['attributes'] + self::$_aDefaultKeys['attributes'] 
-            : self::$_aDefaultKeys['attributes'];
+        $_aDefaultKeys[ 'attributes' ] = isset( $this->aDefaultKeys[ 'attributes' ] ) && is_array( $this->aDefaultKeys[ 'attributes' ] )
+            ? $this->aDefaultKeys[ 'attributes' ] + self::$_aDefaultKeys[ 'attributes' ] 
+            : self::$_aDefaultKeys[ 'attributes' ];
         
         return array(
             'sFieldTypeSlug'        => $sFieldTypeSlug,
@@ -273,7 +273,7 @@ 
      * @since       3.0.0
      * @internal
      */
-    public function _replyToFieldTypeSetter( $sFieldSetType='' ) {
+    public function _replyToFieldTypeSetter( $sFieldSetType = '' ) {
         $this->_sFieldSetType = $sFieldSetType;
     }
     
@@ -327,8 +327,8 @@ 
             wp_enqueue_script( 'media-upload' );    
         }
 
-        if ( in_array( $this->getPageNow(), array( 'media-upload.php', 'async-upload.php', ) ) ) {     
-            add_filter( 'gettext', array( $this, '_replyToReplaceThickBoxText' ) , 1, 2 );     
+        if ( in_array( $this->getPageNow(), array( 'media-upload.php', 'async-upload.php',) ) ) {     
+            add_filter( 'gettext', array( $this, '_replyToReplaceThickBoxText' ), 1, 2 );     
         }
         
     }
@@ -343,7 +343,7 @@ 
         public function _replyToReplaceThickBoxText( $sTranslated, $sText ) {
 
             // Replace the button label in the media thick box.
-            if ( ! in_array( $this->getPageNow(), array( 'media-upload.php', 'async-upload.php' ) ) ) { 
+            if ( !in_array( $this->getPageNow(), array( 'media-upload.php', 'async-upload.php' ) ) ) { 
                 return $sTranslated; 
             }
             if ( $sText !== 'Insert into Post' ) { 
@@ -353,8 +353,8 @@ 
                 return $sTranslated; 
             }
             
-            if ( isset( $_GET['button_label'] ) ) { 
-                return $_GET['button_label']; 
+            if ( isset( $_GET[ 'button_label' ] ) ) { 
+                return $_GET[ 'button_label' ]; 
             }
 
             return $this->oProp->sThickBoxButtonUseThis 
@@ -373,11 +373,11 @@ 
          */
         public function _replyToRemovingMediaLibraryTab( $aTabs ) {
             
-            if ( ! isset( $_REQUEST[ 'enable_external_source' ] ) ) {
+            if ( !isset( $_REQUEST[ 'enable_external_source' ] ) ) {
                 return $aTabs; 
             }
             
-            if ( ! $_REQUEST[ 'enable_external_source' ] ) {
+            if ( !$_REQUEST[ 'enable_external_source' ] ) {
                 unset( $aTabs[ 'type_url' ] ); // removes the 'From URL' tab in the thick box.
             }
             return $aTabs;
@@ -392,7 +392,7 @@ 
      * @since       3.8.0
      * @return      string
      */
-    protected function getLabelContainerAttributes( $aField, $asClassAttributes, array $aAttributes=array() ) {
+    protected function getLabelContainerAttributes( $aField, $asClassAttributes, array $aAttributes = array() ) {
 
         $aAttributes[ 'class' ] = $this->getClassAttribute( $asClassAttributes, $this->getElement( $aAttributes, 'class' ) );
         $aAttributes[ 'style' ] = $this->getStyleAttribute(

Braces +6 added lines, -6 removed lines

@@ -320,14 +320,14 @@ 
         wp_enqueue_script( 'thickbox' );
         wp_enqueue_style( 'thickbox' );
     
-        if ( function_exists( 'wp_enqueue_media' ) ) {     
+        if ( function_exists( 'wp_enqueue_media' ) ) {
             // If the WordPress version is 3.5 or above,
             new AdminPageFramework_Form_View___Script_MediaUploader( $this->oMsg );
         } else {
             wp_enqueue_script( 'media-upload' );    
         }
 
-        if ( in_array( $this->getPageNow(), array( 'media-upload.php', 'async-upload.php', ) ) ) {     
+        if ( in_array( $this->getPageNow(), array( 'media-upload.php', 'async-upload.php', ) ) ) {
             add_filter( 'gettext', array( $this, '_replyToReplaceThickBoxText' ) , 1, 2 );     
         }
         
@@ -343,17 +343,17 @@ 
         public function _replyToReplaceThickBoxText( $sTranslated, $sText ) {
 
             // Replace the button label in the media thick box.
-            if ( ! in_array( $this->getPageNow(), array( 'media-upload.php', 'async-upload.php' ) ) ) { 
+            if ( ! in_array( $this->getPageNow(), array( 'media-upload.php', 'async-upload.php' ) ) ) {
                 return $sTranslated; 
             }
-            if ( $sText !== 'Insert into Post' ) { 
+            if ( $sText !== 'Insert into Post' ) {
                 return $sTranslated; 
             }
-            if ( $this->getQueryValueInURLByKey( wp_get_referer(), 'referrer' ) !== 'admin_page_framework' ) { 
+            if ( $this->getQueryValueInURLByKey( wp_get_referer(), 'referrer' ) !== 'admin_page_framework' ) {
                 return $sTranslated; 
             }
             
-            if ( isset( $_GET['button_label'] ) ) { 
+            if ( isset( $_GET['button_label'] ) ) {
                 return $_GET['button_label']; 
             }
 

Doc Comments +1 added lines

@@ -390,6 +390,7 @@
      * This is used for element that `label_min_width` is applied.
      * 
      * @since       3.8.0
+     * @param string $asClassAttributes
      * @return      string
      */
     protected function getLabelContainerAttributes( $aField, $asClassAttributes, array $aAttributes=array() ) {

development/factory/meta_box/_controller/AdminPageFramework_HelpPane_post_meta_box.php

Spacing +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
     public function _replyToRegisterHelpTabText() {
 
         // Check if the currently loaded page is of meta box page.
-        if ( ! $this->oProp->oCaller->isInThePage() ) {
+        if ( !$this->oProp->oCaller->isInThePage() ) {
             return false; 
         }
 

development/factory/_common/_abstract/AdminPageFramework_Factory_Controller.php

Doc Comments +2 added lines, -2 removed lines

@@ -218,7 +218,7 @@ 
      * @access      public
      * @remark      The actual registration will be performed in the `_replyToRegisterSettings()` method with the `admin_menu` hook.
      * @remark      The `$oForm` property should be created in each extended class.
-     * @param       array|string        $aSection       the section array. If a string is passed, it is considered as a target page slug that will be used as a page slug element from the next call so that the element can be omitted.
+     * @param       array|string        $aSectionset       the section array. If a string is passed, it is considered as a target page slug that will be used as a page slug element from the next call so that the element can be omitted.
      * <h4>Section Definition Array</h4>
      * <ul>
      *      <li>**section_id** - (string) the section ID. Avoid using non-alphabetic characters except underscore and numbers.</li>
@@ -347,7 +347,7 @@ 
      * @since        3.0.0   The scope changed to public to indicate the users will use.
      * @return       void
      * @remark       The $oForm property should be created in each extended class.
-     * @param        array|string       $asField        A field definition array or a string of the target section id.
+     * @param        array|string       $asFieldset        A field definition array or a string of the target section id.
     * <h4>Built-in Field Types</h4>
     * <ul>
     *       <li>[text](./class-AdminPageFramework_FieldType_text.html) - a normal field to enter short text input.</li>

Indentation +187 added lines, -187 removed lines

@@ -306,18 +306,18 @@ 
     }
 
     /**
-    * Adds form fields.
-    *
-    * It inserts the given field definition arrays into the class property and later they are parsed when fields are registered. The field definition array requires specific keys. Refer to the parameter section of this method.
-    *
-    * @since        2.0.0
-    * @since        3.5.3       Removed the parameter declarations as they are caught with the func_get_args().
-    * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-    * @param        array       the field definition array.
-    * @param        array       (optional) another field array.
-    * @param        array       (optional) add more field arrays to the next parameters as many as necessary.
-    * @return       void
-    */
+     * Adds form fields.
+     *
+     * It inserts the given field definition arrays into the class property and later they are parsed when fields are registered. The field definition array requires specific keys. Refer to the parameter section of this method.
+     *
+     * @since        2.0.0
+     * @since        3.5.3       Removed the parameter declarations as they are caught with the func_get_args().
+     * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
+     * @param        array       the field definition array.
+     * @param        array       (optional) another field array.
+     * @param        array       (optional) add more field arrays to the next parameters as many as necessary.
+     * @return       void
+     */
     public function addSettingFields( /* $aField1, $aField2=null, $_and_more=null */ ) {
         foreach( func_get_args() as $_aFieldset ) {
             $this->addSettingField( $_aFieldset );
@@ -348,57 +348,57 @@ 
      * @return       void
      * @remark       The $oForm property should be created in each extended class.
      * @param        array|string       $asField        A field definition array or a string of the target section id.
-    * <h4>Built-in Field Types</h4>
-    * <ul>
-    *       <li>[text](./class-AdminPageFramework_FieldType_text.html) - a normal field to enter short text input.</li>
-    *       <li>[password](./class-AdminPageFramework_FieldType_text.html) - a masked text input field.</li>
-    *       <li>[textarea](./class-AdminPageFramework_FieldType_textarea.html) - a text input field with multiple lines. It supports rich text editors.</li>
-    *       <li>[radio](./class-AdminPageFramework_FieldType_radio.html) - a set of radio buttons that lets the user pick an option.</li>
-    *       <li>[checkbox](./class-AdminPageFramework_FieldType_checkbox.html) - a check box that lets the user enable/disable an item.</li>
-    *       <li>[select](./class-AdminPageFramework_FieldType_select.html) - a drop-down list that lest the user pick one or more item(s) from a list.</li>
-    *       <li>[hidden](./class-AdminPageFramework_FieldType_hidden.html) - a field with invisible input values.</li>
-    *       <li>[file](./class-AdminPageFramework_FieldType_file.html) - a file uploader that lets the user upload files.</li>
-    *       <li>[image](./class-AdminPageFramework_FieldType_image.html) - a text field with an image uploader that lets the user set the image URL.</li>
-    *       <li>[media](./class-AdminPageFramework_FieldType_media.html) - a text field with a media uploader that lets the user set the file URL.</li>
-    *       <li>[color](./class-AdminPageFramework_FieldType_color.html) - a text field with a color picker.</li>
-    *       <li>[submit](./class-AdminPageFramework_FieldType_submit.html) - a submit button that lets the user send the form.</li>
-    *       <li>[export](./class-AdminPageFramework_FieldType_export.html) - a custom submit field that lets the user export stored data.</li>
-    *       <li>[import](./class-AdminPageFramework_FieldType_import.html) - a custom combination field of file and submit fields that let the user import data.</li>
-    *       <li>[posttype](./class-AdminPageFramework_FieldType_posttype.html) - a check-list of post types enabled on the site.</li>
-    *       <li>[taxonomy](./class-AdminPageFramework_FieldType_taxonomy.html) - a set of check-lists of taxonomies enabled on the site in a tabbed box.</li>
-    *       <li>[size](./class-AdminPageFramework_FieldType_size.html) - a combination field of the text and the select fields that let the user set sizes with a selectable unit.</li>
-    *       <li>[section_title](./class-AdminPageFramework_FieldType_section_title.html) - [3.0.0+] a text field type that will be placed in the section title so that it lets the user set the section title. Note that only one field with this field type is allowed per a section.</li>
-    *       <li>[system](./class-AdminPageFramework_FieldType_system.html) - [3.3.0+] a custom text area field that displays the system information including the PHP settings, the framework version, MySQL version etc.</li>
-    *       <li>[inline_mixed](./class-AdminPageFramework_FieldType_inline_mixed.html) - [3.8.0+] a field that include inner fields with different field types. </li>
-    * </ul>
-    * <h4>Field Definition Arguments</h4>
-    * <ul>
-    *       <li>**field_id** - (required, string) the field ID. Avoid using non-alphabetic characters except underscore and numbers.</li>
-    *       <li>**type** - (optional, string) the type of the field. The supported types are listed below. When creating nested fields, this argument can be omitted.</li>
-    *       <li>**section_id** - (optional, string) the section ID that the field belongs to. If not set, the internal `_default` section ID will be assigned.</li>
-    *       <li>**title** - (optional, string) the title of the section.</li>
-    *       <li>**description** - (optional, string) the description of the field which is inserted into the after the input field tag.</li>
-    *       <li>**tip** - (optional, string) the tip for the field which is displayed when the mouse is hovered over the field title.</li>
-    *       <li>**capability** - (optional, string) the <a href="http://codex.wordpress.org/Roles_and_Capabilities">access level</a> of the section. If the page visitor does not have sufficient capability, the section will be invisible to them.</li>
-    *       <li>**error_message** - (optional, string) the error message to display above the input field.</li>
-    *       <li>**before_field** - (optional, string) the HTML string to insert before the input field output.</li>
-    *       <li>**after_field** - (optional, string) the HTML string to insert after the input field output.</li>
-    *       <li>**if** - (optional, boolean) if the passed value is false, the section will not be registered.</li>
-    *       <li>**order** - (optional, integer) the order number of the section. The higher the number is, the lower the position it gets.</li>
-    *       <li>**label** - (optional, string) the text label(s) associated with and displayed along with the input field. Some input types can ignore this key.</li>
-    *       <li>**default** - (optional, string|array) the default value(s) assigned to the input tag's value attribute.</li>
-    *       <li>**value** - (optional, string|array) the value(s) assigned to the input tag's `value` attribute to override the default and the stored value.</li>
-    *       <li>**delimiter** - (optional, string) the HTML string that delimits multiple elements. This is available if the <var>label</var> key is passed as array. It will be enclosed in inline-block elements so the passed HTML string should not contain block elements.</li>
-    *       <li>**before_input** - (optional, string) the HTML string inserted right before the input tag. It will be enclosed in the <code>label</code> tag so the passed HTML string should not contain block elements.</li>
-    *       <li>**after_input** - (optional, string) the HTML string inserted right after the input tag. It will be enclosed in the <code>label</code> tag so the passed HTML string should not contain block elements.</li>
-    *       <li>**label_min_width** - (optional, string) the inline style property of the `min-width` of the label tag for the field. If the unit is not specified, 'px' is applied. Default: `120`. e.g. `100%`</li>
-    *       <li>**help** - (optional, string) the help description added to the contextual help tab.</li>
-    *       <li>**help_aside** - (optional, string) the additional help description for the side bar of the contextual help tab.</li>
-    *       <li>**repeatable** - [3.0.0+] (optional, array|boolean) whether the fields should be repeatable. If it yields true, the plus and the minus buttons appear next to each field that lets the user add/remove the fields. Optionally an setting array can be passed.
-    *           <h5>Repeatable Fields Setting Array</h5>
-    *           <ul>
-    *                 <li>**max** - the allowed maximum number of fields to be repeated.</li>
-    *                 <li>**min** - the allowed minimum number of fields to be repeated.</li>
+     * <h4>Built-in Field Types</h4>
+     * <ul>
+     *       <li>[text](./class-AdminPageFramework_FieldType_text.html) - a normal field to enter short text input.</li>
+     *       <li>[password](./class-AdminPageFramework_FieldType_text.html) - a masked text input field.</li>
+     *       <li>[textarea](./class-AdminPageFramework_FieldType_textarea.html) - a text input field with multiple lines. It supports rich text editors.</li>
+     *       <li>[radio](./class-AdminPageFramework_FieldType_radio.html) - a set of radio buttons that lets the user pick an option.</li>
+     *       <li>[checkbox](./class-AdminPageFramework_FieldType_checkbox.html) - a check box that lets the user enable/disable an item.</li>
+     *       <li>[select](./class-AdminPageFramework_FieldType_select.html) - a drop-down list that lest the user pick one or more item(s) from a list.</li>
+     *       <li>[hidden](./class-AdminPageFramework_FieldType_hidden.html) - a field with invisible input values.</li>
+     *       <li>[file](./class-AdminPageFramework_FieldType_file.html) - a file uploader that lets the user upload files.</li>
+     *       <li>[image](./class-AdminPageFramework_FieldType_image.html) - a text field with an image uploader that lets the user set the image URL.</li>
+     *       <li>[media](./class-AdminPageFramework_FieldType_media.html) - a text field with a media uploader that lets the user set the file URL.</li>
+     *       <li>[color](./class-AdminPageFramework_FieldType_color.html) - a text field with a color picker.</li>
+     *       <li>[submit](./class-AdminPageFramework_FieldType_submit.html) - a submit button that lets the user send the form.</li>
+     *       <li>[export](./class-AdminPageFramework_FieldType_export.html) - a custom submit field that lets the user export stored data.</li>
+     *       <li>[import](./class-AdminPageFramework_FieldType_import.html) - a custom combination field of file and submit fields that let the user import data.</li>
+     *       <li>[posttype](./class-AdminPageFramework_FieldType_posttype.html) - a check-list of post types enabled on the site.</li>
+     *       <li>[taxonomy](./class-AdminPageFramework_FieldType_taxonomy.html) - a set of check-lists of taxonomies enabled on the site in a tabbed box.</li>
+     *       <li>[size](./class-AdminPageFramework_FieldType_size.html) - a combination field of the text and the select fields that let the user set sizes with a selectable unit.</li>
+     *       <li>[section_title](./class-AdminPageFramework_FieldType_section_title.html) - [3.0.0+] a text field type that will be placed in the section title so that it lets the user set the section title. Note that only one field with this field type is allowed per a section.</li>
+     *       <li>[system](./class-AdminPageFramework_FieldType_system.html) - [3.3.0+] a custom text area field that displays the system information including the PHP settings, the framework version, MySQL version etc.</li>
+     *       <li>[inline_mixed](./class-AdminPageFramework_FieldType_inline_mixed.html) - [3.8.0+] a field that include inner fields with different field types. </li>
+     * </ul>
+     * <h4>Field Definition Arguments</h4>
+     * <ul>
+     *       <li>**field_id** - (required, string) the field ID. Avoid using non-alphabetic characters except underscore and numbers.</li>
+     *       <li>**type** - (optional, string) the type of the field. The supported types are listed below. When creating nested fields, this argument can be omitted.</li>
+     *       <li>**section_id** - (optional, string) the section ID that the field belongs to. If not set, the internal `_default` section ID will be assigned.</li>
+     *       <li>**title** - (optional, string) the title of the section.</li>
+     *       <li>**description** - (optional, string) the description of the field which is inserted into the after the input field tag.</li>
+     *       <li>**tip** - (optional, string) the tip for the field which is displayed when the mouse is hovered over the field title.</li>
+     *       <li>**capability** - (optional, string) the <a href="http://codex.wordpress.org/Roles_and_Capabilities">access level</a> of the section. If the page visitor does not have sufficient capability, the section will be invisible to them.</li>
+     *       <li>**error_message** - (optional, string) the error message to display above the input field.</li>
+     *       <li>**before_field** - (optional, string) the HTML string to insert before the input field output.</li>
+     *       <li>**after_field** - (optional, string) the HTML string to insert after the input field output.</li>
+     *       <li>**if** - (optional, boolean) if the passed value is false, the section will not be registered.</li>
+     *       <li>**order** - (optional, integer) the order number of the section. The higher the number is, the lower the position it gets.</li>
+     *       <li>**label** - (optional, string) the text label(s) associated with and displayed along with the input field. Some input types can ignore this key.</li>
+     *       <li>**default** - (optional, string|array) the default value(s) assigned to the input tag's value attribute.</li>
+     *       <li>**value** - (optional, string|array) the value(s) assigned to the input tag's `value` attribute to override the default and the stored value.</li>
+     *       <li>**delimiter** - (optional, string) the HTML string that delimits multiple elements. This is available if the <var>label</var> key is passed as array. It will be enclosed in inline-block elements so the passed HTML string should not contain block elements.</li>
+     *       <li>**before_input** - (optional, string) the HTML string inserted right before the input tag. It will be enclosed in the <code>label</code> tag so the passed HTML string should not contain block elements.</li>
+     *       <li>**after_input** - (optional, string) the HTML string inserted right after the input tag. It will be enclosed in the <code>label</code> tag so the passed HTML string should not contain block elements.</li>
+     *       <li>**label_min_width** - (optional, string) the inline style property of the `min-width` of the label tag for the field. If the unit is not specified, 'px' is applied. Default: `120`. e.g. `100%`</li>
+     *       <li>**help** - (optional, string) the help description added to the contextual help tab.</li>
+     *       <li>**help_aside** - (optional, string) the additional help description for the side bar of the contextual help tab.</li>
+     *       <li>**repeatable** - [3.0.0+] (optional, array|boolean) whether the fields should be repeatable. If it yields true, the plus and the minus buttons appear next to each field that lets the user add/remove the fields. Optionally an setting array can be passed.
+     *           <h5>Repeatable Fields Setting Array</h5>
+     *           <ul>
+     *                 <li>**max** - the allowed maximum number of fields to be repeated.</li>
+     *                 <li>**min** - the allowed minimum number of fields to be repeated.</li>
      *                <li>**disabled** - (optional, boolean|array) [3.8.13+]
      *                    <ul>
      *                        <li>**message** - (optional, string) the message to show when the user clicks on the `Add` repeatable button.</li>
@@ -407,108 +407,108 @@ 
      *                        <li>**box_width** - (optional, integer) the height of the modal window that displays the message. Default: 100.</li>
      *                    <ul>
      *                </li>
-    *           </ul>
-    *       </li>
-    *       <li>**sortable** - [3.0.0+] (optional, boolean) whether the fields should be sortable. If it yields true, the fields will be enclosed in a draggable box.
-    *       <li>**attributes** - [3.0.0+] (optional, array) holds key-value pairs representing the attribute and its property. Note that some field types have specific keys in the first dimensions. e.g. `array( 'class' => 'my_custom_class_selector', 'style' => 'background-color:#777', 'size' => 20, )` Every field holds the following nested attribute definition arrays.
-    *           <ul>
-    *               <li>**fieldrow** - the `td` tag element containing the field output.</li>
-    *               <li>**fieldset** - the `fieldset` tag element containing the field output.</li>
-    *               <li>**fields** - the `div` tag element containing the sub-fields and the main field.</li>
-    *               <li>**field** - the `div` tag element containing each field.</li>
-    *           </ul>
-    *       </li>
-    *       <li>**show_title_column** - [3.0.0+] (optional, boolean) If true, the field title column will be omitted from the output.</li>
-    *       <li>**hidden** - [3.0.0+] (optional, boolean) If true, the entire field row output will be invisible with the inline style attribute of `style="display:none"`.</li>
-    *       <li>**save** - [3.6.0+] (optional, boolean) If `false`, the field value will not be saved. Default: `true`</li>
-    *       <li>**content** - (optional, string|array) [3.6.1+] a custom section output. [3.8.0+] Supports an array to be passed for nested and inline-mixed fields. If an array holding field definitions is set, those fields will be nested.
-    *           <h4>Example</h4>
-    * <pre><code>
-    *   $this->addSettingFields(
-    *       'my_section_id', // the target section ID - pass dimensional keys of the section
-    *       array(
-    *           'field_id'      => 'Y',
-    *           'title'         => __( 'Y', 'admin-page-framework-loader' ),
-    *           'description'   => __( 'By passing an array of field definition to the <code>content</code> argument, you can nest fields.', 'admin-page-framework-loader' )
-    *               . ' ' . __( 'Also the <code>type</code> argument can be omitted.', 'admin-page-framework-loader' ),
-    *           'content'       => array(
-    *               array(
-    *                   'field_id'      => 'i',
-    *                   'title'         => __( 'i', 'admin-page-framework-loader' ),
-    *                   'type'          => 'textarea',
-    *               ),
-    *               array(
-    *                   'field_id'      => 'ii',
-    *                   'title'         => __( 'ii', 'admin-page-framework-loader' ),
-    *                   'type'          => 'color',
-    *               ),
-    *               array(
-    *                   'field_id'      => 'iii',
-    *                   'title'         => __( 'iii', 'admin-page-framework-loader' ),
-    *                   'repeatable'    => true,
-    *                   'sortable'      => true,
-    *                   'content'       => array(
-    *                       array(
-    *                           'field_id'      => 'a',
-    *                           'title'         => __( 'a', 'admin-page-framework-loader' ),
-    *                           'type'          => 'image',
-    *                           'attributes'    => array(
-    *                               'preview' => array(
-    *                                   'style' => 'max-width: 200px;',
-    *                               ),
-    *                           ),
-    *                       ),
-    *                       array(
-    *                           'field_id'      => 'b',
-    *                           'title'         => __( 'b', 'admin-page-framework-loader' ),
-    *                           'content'       => array(
-    *                               array(
-    *                                   'field_id'      => 'first',
-    *                                   'title'         => __( '1st', 'admin-page-framework-loader' ),
-    *                                   'type'          => 'color',
-    *                                   'repeatable'    => true,
-    *                                   'sortable'      => true,
-    *                               ),
-    *                               array(
-    *                                   'field_id'      => 'second',
-    *                                   'title'         => __( '2nd', 'admin-page-framework-loader' ),
-    *                                   'type'          => 'size',
-    *                               ),
-    *                               array(
-    *                                   'field_id'      => 'third',
-    *                                   'title'         => __( '3rd', 'admin-page-framework-loader' ),
-    *                                   'type'          => 'select',
-    *                                   'label'         => array(
-    *                                       'x' => 'X',
-    *                                       'y' => 'Y',
-    *                                       'z' => 'Z',
-    *                                   ),
-    *                               ),
-    *                           ),
-    *                           // 'description'   => '',
-    *                       ),
-    *                       array(
-    *                           'field_id'      => 'c',
-    *                           'title'         => __( 'c', 'admin-page-framework-loader' ),
-    *                           'type'          => 'radio',
-    *                           'label'         => array(
-    *                               'a' => __( 'Apple', 'admin-page-framework-loader' ),
-    *                               'b' => __( 'Banana', 'admin-page-framework-loader' ),
-    *                               'c' => __( 'Cherry', 'admin-page-framework-loader' ),
-    *                           ),
-    *                           'default'       => 'b',
-    *                       ),
-    *                   )
-    *               ),
-    *           ),
-    *       )
-    *   );
-    * </code></pre>
-    *       </li>
-    *       <li>**placement** - [3.8.0+] (optional, string) Specifies where the field is rendered. Either `normal` `section_title` or `field_title` is accepted. `field_title` can only be used by nested fields defined in the `content` argument.  Default: `normal`</li>
-    *       <li>**show_debug_info** - (optional, boolean) [3.8.8+] Whether to show debug information such as field definition tool-tips. Default: `true`.</li>
-    * </ul>
-    */
+     *           </ul>
+     *       </li>
+     *       <li>**sortable** - [3.0.0+] (optional, boolean) whether the fields should be sortable. If it yields true, the fields will be enclosed in a draggable box.
+     *       <li>**attributes** - [3.0.0+] (optional, array) holds key-value pairs representing the attribute and its property. Note that some field types have specific keys in the first dimensions. e.g. `array( 'class' => 'my_custom_class_selector', 'style' => 'background-color:#777', 'size' => 20, )` Every field holds the following nested attribute definition arrays.
+     *           <ul>
+     *               <li>**fieldrow** - the `td` tag element containing the field output.</li>
+     *               <li>**fieldset** - the `fieldset` tag element containing the field output.</li>
+     *               <li>**fields** - the `div` tag element containing the sub-fields and the main field.</li>
+     *               <li>**field** - the `div` tag element containing each field.</li>
+     *           </ul>
+     *       </li>
+     *       <li>**show_title_column** - [3.0.0+] (optional, boolean) If true, the field title column will be omitted from the output.</li>
+     *       <li>**hidden** - [3.0.0+] (optional, boolean) If true, the entire field row output will be invisible with the inline style attribute of `style="display:none"`.</li>
+     *       <li>**save** - [3.6.0+] (optional, boolean) If `false`, the field value will not be saved. Default: `true`</li>
+     *       <li>**content** - (optional, string|array) [3.6.1+] a custom section output. [3.8.0+] Supports an array to be passed for nested and inline-mixed fields. If an array holding field definitions is set, those fields will be nested.
+     *           <h4>Example</h4>
+     * <pre><code>
+     *   $this->addSettingFields(
+     *       'my_section_id', // the target section ID - pass dimensional keys of the section
+     *       array(
+     *           'field_id'      => 'Y',
+     *           'title'         => __( 'Y', 'admin-page-framework-loader' ),
+     *           'description'   => __( 'By passing an array of field definition to the <code>content</code> argument, you can nest fields.', 'admin-page-framework-loader' )
+     *               . ' ' . __( 'Also the <code>type</code> argument can be omitted.', 'admin-page-framework-loader' ),
+     *           'content'       => array(
+     *               array(
+     *                   'field_id'      => 'i',
+     *                   'title'         => __( 'i', 'admin-page-framework-loader' ),
+     *                   'type'          => 'textarea',
+     *               ),
+     *               array(
+     *                   'field_id'      => 'ii',
+     *                   'title'         => __( 'ii', 'admin-page-framework-loader' ),
+     *                   'type'          => 'color',
+     *               ),
+     *               array(
+     *                   'field_id'      => 'iii',
+     *                   'title'         => __( 'iii', 'admin-page-framework-loader' ),
+     *                   'repeatable'    => true,
+     *                   'sortable'      => true,
+     *                   'content'       => array(
+     *                       array(
+     *                           'field_id'      => 'a',
+     *                           'title'         => __( 'a', 'admin-page-framework-loader' ),
+     *                           'type'          => 'image',
+     *                           'attributes'    => array(
+     *                               'preview' => array(
+     *                                   'style' => 'max-width: 200px;',
+     *                               ),
+     *                           ),
+     *                       ),
+     *                       array(
+     *                           'field_id'      => 'b',
+     *                           'title'         => __( 'b', 'admin-page-framework-loader' ),
+     *                           'content'       => array(
+     *                               array(
+     *                                   'field_id'      => 'first',
+     *                                   'title'         => __( '1st', 'admin-page-framework-loader' ),
+     *                                   'type'          => 'color',
+     *                                   'repeatable'    => true,
+     *                                   'sortable'      => true,
+     *                               ),
+     *                               array(
+     *                                   'field_id'      => 'second',
+     *                                   'title'         => __( '2nd', 'admin-page-framework-loader' ),
+     *                                   'type'          => 'size',
+     *                               ),
+     *                               array(
+     *                                   'field_id'      => 'third',
+     *                                   'title'         => __( '3rd', 'admin-page-framework-loader' ),
+     *                                   'type'          => 'select',
+     *                                   'label'         => array(
+     *                                       'x' => 'X',
+     *                                       'y' => 'Y',
+     *                                       'z' => 'Z',
+     *                                   ),
+     *                               ),
+     *                           ),
+     *                           // 'description'   => '',
+     *                       ),
+     *                       array(
+     *                           'field_id'      => 'c',
+     *                           'title'         => __( 'c', 'admin-page-framework-loader' ),
+     *                           'type'          => 'radio',
+     *                           'label'         => array(
+     *                               'a' => __( 'Apple', 'admin-page-framework-loader' ),
+     *                               'b' => __( 'Banana', 'admin-page-framework-loader' ),
+     *                               'c' => __( 'Cherry', 'admin-page-framework-loader' ),
+     *                           ),
+     *                           'default'       => 'b',
+     *                       ),
+     *                   )
+     *               ),
+     *           ),
+     *       )
+     *   );
+     * </code></pre>
+     *       </li>
+     *       <li>**placement** - [3.8.0+] (optional, string) Specifies where the field is rendered. Either `normal` `section_title` or `field_title` is accepted. `field_title` can only be used by nested fields defined in the `content` argument.  Default: `normal`</li>
+     *       <li>**show_debug_info** - (optional, boolean) [3.8.8+] Whether to show debug information such as field definition tool-tips. Default: `true`.</li>
+     * </ul>
+     */
     public function addSettingField( $asFieldset ) {
         if ( method_exists( $this->oForm, 'addField' ) ) {
             $this->oForm->addField( $asFieldset );
@@ -572,28 +572,28 @@ 
     }
 
     /**
-    * Sets the given message to be displayed in the next page load.
-    *
-    * This is used to inform users about the submitted input data, such as "Updated successfully." or "Problem occurred." etc.
-    * and normally used in validation callback methods.
-    *
-    * <h4>Example</h4>
-    * `
-    * if ( ! $bVerified ) {
-    *       $this->setFieldErrors( $aErrors );
-    *       $this->setSettingNotice( 'There was an error in your input.' );
-    *       return $aOldPageOptions;
-    * }
-    * `
-    *
-    * @since        3.0.4
-    * @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
-    */
+     * Sets the given message to be displayed in the next page load.
+     *
+     * This is used to inform users about the submitted input data, such as "Updated successfully." or "Problem occurred." etc.
+     * and normally used in validation callback methods.
+     *
+     * <h4>Example</h4>
+     * `
+     * if ( ! $bVerified ) {
+     *       $this->setFieldErrors( $aErrors );
+     *       $this->setSettingNotice( 'There was an error in your input.' );
+     *       return $aOldPageOptions;
+     * }
+     * `
+     *
+     * @since        3.0.4
+     * @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 setSettingNotice( $sMessage, $sType='error', $asAttributes=array(), $bOverride=true ) {
         $this->oForm->setSubmitNotice(
             $sMessage,

Spacing +11 added lines, -11 removed lines

@@ -53,7 +53,7 @@ 
      * @return      array|string
      * @since       3.7.0
      */
-    public function getMessage( $sKey='' ) {
+    public function getMessage( $sKey = '' ) {
         return $this->oMsg->get( $sKey );
     }
 
@@ -73,7 +73,7 @@ 
      * @return      array       The array holing the queued items.
      * @internal
      */
-    public function enqueueStyles( $aSRCs, $_vArg2=null ) {}
+    public function enqueueStyles( $aSRCs, $_vArg2 = null ) {}
 
     /**
      * Enqueues a style of the given source.
@@ -93,7 +93,7 @@ 
      * @return      string      The style handle ID. If the passed url is not a valid url string, an empty string will be returned.
      * @internal
      */
-    public function enqueueStyle( $sSRC, $_vArg2=null ) {}
+    public function enqueueStyle( $sSRC, $_vArg2 = null ) {}
 
     /**
      * Enqueues scripts by the given sources.
@@ -114,7 +114,7 @@ 
      * @return      array        The array holding the queued items.
      * @internal
      */
-    public function enqueueScripts( $aSRCs, $_vArg2=null ) {}
+    public function enqueueScripts( $aSRCs, $_vArg2 = null ) {}
     /**
      * Enqueues a script by the given source.
      *
@@ -146,7 +146,7 @@ 
      * @return      string      The script handle ID. If the passed url is not a valid url string, an empty string will be returned.
      * @internal
      */
-    public function enqueueScript( $sSRC, $_vArg2=null ) {}
+    public function enqueueScript( $sSRC, $_vArg2 = null ) {}
 
     /*
      * Help Pane
@@ -164,7 +164,7 @@ 
      * @since       2.1.0
      * @remark      This method just adds the given text into the class property. The actual registration will be performed with the `replyToRegisterHelpTabTextForMetaBox()` method.
      */
-    public function addHelpText( $sHTMLContent, $sHTMLSidebarContent="" ) {
+    public function addHelpText( $sHTMLContent, $sHTMLSidebarContent = "" ) {
         if ( method_exists( $this->oHelpPane, '_addHelpText' ) ) {
             $this->oHelpPane->_addHelpText( $sHTMLContent, $sHTMLSidebarContent );
         }
@@ -200,7 +200,7 @@ 
      */
     public function addSettingSections( /* $aSection1, $aSection2=null, $_and_more=null */ ) {
 
-        foreach( func_get_args() as $_asSectionset ) {
+        foreach ( func_get_args() as $_asSectionset ) {
             $this->addSettingSection( $_asSectionset );
         }
 
@@ -286,7 +286,7 @@ 
      */
     public function addSettingSection( $aSectionset ) {
 
-        if ( ! is_array( $aSectionset ) ) {
+        if ( !is_array( $aSectionset ) ) {
             return;
         }
 
@@ -319,7 +319,7 @@ 
     * @return       void
     */
     public function addSettingFields( /* $aField1, $aField2=null, $_and_more=null */ ) {
-        foreach( func_get_args() as $_aFieldset ) {
+        foreach ( func_get_args() as $_aFieldset ) {
             $this->addSettingField( $_aFieldset );
         }
     }
@@ -594,7 +594,7 @@ 
     * @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 setSettingNotice( $sMessage, $sType='error', $asAttributes=array(), $bOverride=true ) {
+    public function setSettingNotice( $sMessage, $sType = 'error', $asAttributes = array(), $bOverride = true ) {
         $this->oForm->setSubmitNotice(
             $sMessage,
             $sType,
@@ -613,7 +613,7 @@ 
      * @param       string      $sType If empty, the method will check if a message exists in all types. Otherwise, it checks the existence of a message of the specified type.
      * @return      boolean     True if a setting notice is set; otherwise, false.
      */
-    public function hasSettingNotice( $sType='' ) {
+    public function hasSettingNotice( $sType = '' ) {
         return $this->oForm->hasSubmitNotice( $sType );
     }
 

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

Doc Comments +2 added lines

@@ -192,6 +192,8 @@
     }
     /**
      * Trims a trailing sub-string if exists.
+     * @param string $sString
+     * @param string $sSuffix
      * @return      string
      * @since       3.7.2
      */

Spacing +9 added lines, -9 removed lines

@@ -35,10 +35,10 @@ 
      * @since       3.8.4   When non-true value is passed, `0px` will be returned.
      * @return      string
      */
-    static public function getLengthSanitized( $sLength, $sUnit='px' ) {
+    static public function getLengthSanitized( $sLength, $sUnit = 'px' ) {
         $sLength = $sLength ? $sLength : 0;
         return is_numeric( $sLength )
-            ? $sLength . $sUnit
+            ? $sLength.$sUnit
             : $sLength;
     }
 
@@ -80,9 +80,9 @@ 
      * @since       3.8.11      Renamed from `fixNumber()`.
      * @return      string|integer      A numeric value will be returned.
      */
-    static public function getNumberFixed( $nToFix, $nDefault, $nMin='', $nMax='' ) {
+    static public function getNumberFixed( $nToFix, $nDefault, $nMin = '', $nMax = '' ) {
 
-        if ( ! is_numeric( trim( $nToFix ) ) ) {
+        if ( !is_numeric( trim( $nToFix ) ) ) {
             return $nDefault;
         }
         if ( $nMin !== '' && $nToFix < $nMin ) {
@@ -100,7 +100,7 @@ 
          * @return      string|integer      A numeric value will be returned.
          * @deprecated  3.8.11
          */
-        static public function fixNumber( $nToFix, $nDefault, $nMin='', $nMax='' ) {
+        static public function fixNumber( $nToFix, $nDefault, $nMin = '', $nMax = '' ) {
             return self::getNumberFixed( $nToFix, $nDefault, $nMin, $nMax );
         }
 
@@ -113,7 +113,7 @@ 
      */
     static public function getCSSMinified( $sCSSRules ) {
         return str_replace(
-            array( "\r\n", "\r", "\n", "\t", '  ', '    ', '    '),  // remove line breaks, tab, and white sspaces.
+            array( "\r\n", "\r", "\n", "\t", '  ', '    ', '    ' ), // remove line breaks, tab, and white sspaces.
             '',
             preg_replace( '!/\*[^*]*\*+([^/][^*]*\*+)*/!', '', $sCSSRules ) // remove comments
         );
@@ -150,8 +150,8 @@ 
      */
     static public function getNumberOfReadableSize( $nSize ) {
 
-        $_nReturn     = substr( $nSize, 0, -1 );
-        switch( strtoupper( substr( $nSize, -1 ) ) ) {
+        $_nReturn = substr( $nSize, 0, -1 );
+        switch ( strtoupper( substr( $nSize, -1 ) ) ) {
             case 'P':
                 $_nReturn *= 1024;
             case 'T':
@@ -177,7 +177,7 @@ 
         $_nLog      = log( $nBytes, 1024 );
         $_iPower    = ( int ) $_nLog;
         $_iSize     = pow( 1024, $_nLog - $_iPower );
-        return $_iSize . $_aUnits[ $_iPower ];
+        return $_iSize.$_aUnits[ $_iPower ];
     }
 
     /**

development/factory/admin_page/form/AdminPageFramework_Form_admin_page.php

Doc Comments +1 added lines

@@ -458,6 +458,7 @@
      * @internal
      * @since       3.5.3
      * @since       3.7.0      Moved from `AdminPageFramework_FormDefinition_Page`.
+     * @param string $sTabSlug
      * @return      boolean
      */
     private function _isThisSectionSetToThisTab( $sSectionPath, $sPageSlug, $sTabSlug ) {

Spacing +19 added lines, -19 removed lines

@@ -51,16 +51,16 @@ 
     public function getPageOnlyOptions( $aOptions, $sPageSlug ) {
 
         $_aStoredOptionsOfThePage = array();
-        foreach( $this->aFieldsets as $_sSectionID => $_aSubSectionsOrFields ) {
+        foreach ( $this->aFieldsets as $_sSectionID => $_aSubSectionsOrFields ) {
 
             // Check the section
-            if ( ! $this->_isThisSectionSetToThisPage( $_sSectionID, $sPageSlug ) ) {
+            if ( !$this->_isThisSectionSetToThisPage( $_sSectionID, $sPageSlug ) ) {
                 continue;
             }
 
             // At this point, the element belongs the given page slug as the section is of the given page slug's.
             $this->_setPageOnlyOptions(
-                $_aStoredOptionsOfThePage,  // by reference - gets updated in the method.
+                $_aStoredOptionsOfThePage, // by reference - gets updated in the method.
                 $aOptions,
                 $_aSubSectionsOrFields,
                 $sPageSlug,
@@ -80,7 +80,7 @@ 
          * @internal
          */
         private function _setPageOnlyOptions( array &$_aStoredOptionsOfThePage, array $aOptions, array $_aSubSectionsOrFields, $sPageSlug, $_sSectionID ) {
-            foreach( $_aSubSectionsOrFields as $_sFieldID => $_aFieldset ) {
+            foreach ( $_aSubSectionsOrFields as $_sFieldID => $_aFieldset ) {
 
                 // If it's a sub-section array,
                 if ( $this->isNumericInteger( $_sFieldID ) ) {
@@ -152,7 +152,7 @@ 
     public function getOtherPageOptions( $aOptions, $sPageSlug ) {
 
         $_aStoredOptionsNotOfThePage = array();
-        foreach( $this->aFieldsets as $_sSectionID => $_aSubSectionsOrFields ) {
+        foreach ( $this->aFieldsets as $_sSectionID => $_aSubSectionsOrFields ) {
 
             // Check the section
             if ( $this->_isThisSectionSetToThisPage( $_sSectionID, $sPageSlug ) ) {
@@ -181,7 +181,7 @@ 
          * @internal
          */
         private function _setOtherPageOptions( array &$_aStoredOptionsNotOfThePage, array $aOptions, array $_aSubSectionsOrFields, $sPageSlug ) {
-            foreach( $_aSubSectionsOrFields as $_sFieldID => $_aFieldset ) {
+            foreach ( $_aSubSectionsOrFields as $_sFieldID => $_aFieldset ) {
 
                 // It's a sub-section array.
                 if ( $this->isNumericInteger( $_sFieldID ) ) {
@@ -244,7 +244,7 @@ 
     public function getOtherTabOptions( $aOptions, $sPageSlug, $sTabSlug ) {
 
         $_aStoredOptionsNotOfTheTab = array();
-        foreach( $this->aFieldsets as $_sSectionPath => $_aSubSectionsOrFields ) {
+        foreach ( $this->aFieldsets as $_sSectionPath => $_aSubSectionsOrFields ) {
 
             // If the section is of the given page and the given tab, skip.
             if ( $this->_isThisSectionSetToThisTab( $_sSectionPath, $sPageSlug, $sTabSlug ) ) {
@@ -275,7 +275,7 @@ 
         private function _setOtherTabOptions( array &$_aStoredOptionsNotOfTheTab, array $aOptions, array $_aSubSectionsOrFields, $sSectionPath ) {
 
             // At this point, the passed element belongs to the other tabs since the section of the given tab is skipped.
-            foreach ( $_aSubSectionsOrFields as $_isSubSectionIndexOrFieldID => $_aSubSectionOrField  ) {
+            foreach ( $_aSubSectionsOrFields as $_isSubSectionIndexOrFieldID => $_aSubSectionOrField ) {
 
                 // If it's a sub section
                 if ( $this->isNumericInteger( $_isSubSectionIndexOrFieldID ) ) {
@@ -333,7 +333,7 @@ 
      * @since       3.7.0      Moved from `AdminPageFramework_FormDefinition_Page`.
      * @return      array
      */
-    public function getTabOptions( $aOptions, $sPageSlug, $sTabSlug='' ) {
+    public function getTabOptions( $aOptions, $sPageSlug, $sTabSlug = '' ) {
 
         $_aOtherTabOptions = $this->getOtherTabOptions( $aOptions, $sPageSlug, $sTabSlug );
         $_aTabOptions      = $this->invertCastArrayContents( $aOptions, $_aOtherTabOptions );
@@ -351,17 +351,17 @@ 
      * @since       3.7.0      Moved from `AdminPageFramework_FormDefinition_Page`.
      * @return      array
      */
-    public function getTabOnlyOptions( array $aOptions, $sPageSlug, $sTabSlug='' ) {
+    public function getTabOnlyOptions( array $aOptions, $sPageSlug, $sTabSlug = '' ) {
 
         $_aStoredOptionsOfTheTab = array();
-        if ( ! $sTabSlug ) {
+        if ( !$sTabSlug ) {
             return $_aStoredOptionsOfTheTab;
         }
 
-        foreach( $this->aFieldsets as $_sSectionID => $_aSubSectionsOrFields ) {
+        foreach ( $this->aFieldsets as $_sSectionID => $_aSubSectionsOrFields ) {
 
             // Check the section
-            if ( ! $this->_isThisSectionSetToThisTab( $_sSectionID, $sPageSlug, $sTabSlug ) ) {
+            if ( !$this->_isThisSectionSetToThisTab( $_sSectionID, $sPageSlug, $sTabSlug ) ) {
                 continue;
             }
 
@@ -387,7 +387,7 @@ 
          */
         private function _setTabOnlyOptions( array &$_aStoredOptionsOfTheTab, array $aOptions, array $_aSubSectionsOrFields, $_sSectionID ) {
 
-            foreach( $_aSubSectionsOrFields as $_sFieldID => $_aFieldset ) {
+            foreach ( $_aSubSectionsOrFields as $_sFieldID => $_aFieldset ) {
 
                 // if it's a sub-section array.
                 if ( $this->isNumericInteger( $_sFieldID ) ) {
@@ -444,7 +444,7 @@ 
      */
     private function _isThisSectionSetToThisPage( $sSectionPath, $sPageSlug ) {
 
-        if ( ! isset( $this->aSectionsets[ $sSectionPath ][ 'page_slug' ] ) ) {
+        if ( !isset( $this->aSectionsets[ $sSectionPath ][ 'page_slug' ] ) ) {
             return false;
         }
         return (
@@ -462,10 +462,10 @@ 
      */
     private function _isThisSectionSetToThisTab( $sSectionPath, $sPageSlug, $sTabSlug ) {
 
-        if ( ! $this->_isThisSectionSetToThisPage( $sSectionPath, $sPageSlug ) ) {
+        if ( !$this->_isThisSectionSetToThisPage( $sSectionPath, $sPageSlug ) ) {
             return false;
         }
-        if ( ! isset( $this->aSectionsets[ $sSectionPath ][ 'tab_slug' ] ) ) {
+        if ( !isset( $this->aSectionsets[ $sSectionPath ][ 'tab_slug' ] ) ) {
             return false;
         }
         return (
@@ -482,9 +482,9 @@ 
      */
     private function _setOptionValue( &$aSubject, $asDimensionalPath, $aOptions ) {
         $_aDimensionalPath = $this->getAsArray( $asDimensionalPath );
-        $_mValue     = $this->getElement(
+        $_mValue = $this->getElement(
             $aOptions,
-            $_aDimensionalPath,    // as of 3.7.0, it can be an array or string
+            $_aDimensionalPath, // as of 3.7.0, it can be an array or string
             null
         );
         if ( isset( $_mValue ) ) {

development/factory/post_type/_view/AdminPageFramework_PageLoadInfo_post_type.php

Spacing +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
         if ( in_array( $oProp->sClassName, self::$aClassNames ) )
             return self::$_oInstance;
         
-        self::$aClassNames[] = $oProp->sClassName;
+        self::$aClassNames[ ] = $oProp->sClassName;
         self::$_oInstance = new AdminPageFramework_PageLoadInfo_post_type( $oProp, $oMsg );
         
         return self::$_oInstance;
@@ -43,7 +43,7 @@ 
     public function _replyToSetPageLoadInfoInFooter() {
 
         // Some users sets $_GET['post_type'] element even in regular admin pages. In that case, do not load the style to avoid duplicates.
-        if ( isset( $_GET['page'] ) && $_GET['page'] ) { return; }
+        if ( isset( $_GET[ 'page' ] ) && $_GET[ 'page' ] ) { return; }
     
         // For post type pages
         if ( 

Braces +3 added lines, -2 removed lines

@@ -26,8 +26,9 @@
      */
     public static function instantiate( $oProp, $oMsg ) {
         
-        if ( in_array( $oProp->sClassName, self::$aClassNames ) )
-            return self::$_oInstance;
+        if ( in_array( $oProp->sClassName, self::$aClassNames ) ) {
+                    return self::$_oInstance;
+        }
         
         self::$aClassNames[] = $oProp->sClassName;
         self::$_oInstance = new AdminPageFramework_PageLoadInfo_post_type( $oProp, $oMsg );

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

Spacing +35 added lines, -35 removed lines

@@ -186,7 +186,7 @@ 
     /**
      * Defines the field type slugs used for this field type.
      */
-    public $aFieldTypeSlugs = array( 'submit', );
+    public $aFieldTypeSlugs = array( 'submit',);
     
     /**
      * Defines the default key-values of this field type. 
@@ -197,7 +197,7 @@ 
         'redirect_url'  => null,
         'href'          => null,
         'reset'         => null, 
-        'email'         => null,    // [3.3.0+] string of an email address to send to or it can be an array with the following keys.
+        'email'         => null, // [3.3.0+] string of an email address to send to or it can be an array with the following keys.
         /* 
             array(
                 'to'            => null,    // string|array     The email address to send to or an array representing the key structure of the submitted form data holding the value. The first key should be the section ID and the second key is the the field ID.
@@ -207,7 +207,7 @@ 
                 'attachments'   => null,    // string|array     The file path(s) or an array representing the key structure of the submitted form data holding the value. The first key should be the section ID and the second key is the the field ID.
             )
         */
-        'skip_confirmation' => false,   // 3.7.6+ For emails.
+        'skip_confirmation' => false, // 3.7.6+ For emails.
         'attributes'    => array(
             'class' => 'button button-primary',
         ),    
@@ -247,16 +247,16 @@ 
 
         return 
             $aField[ 'before_label' ]
-            . "<div " . $this->getAttributes( $_aLabelContainerAttributes ) . ">"
+            . "<div ".$this->getAttributes( $_aLabelContainerAttributes ).">"
                 . $this->_getExtraFieldsBeforeLabel( $aField ) // this is for the import field type that cannot place file input tag inside the label tag.
-                . "<label " . $this->getAttributes( $_aLabelAttributes ) . ">"
+                . "<label ".$this->getAttributes( $_aLabelAttributes ).">"
                     . $aField[ 'before_input' ]
                     . $this->_getExtraInputFields( $aField )
-                    . "<input " . $this->getAttributes( $_aInputAttributes ) . " />" // this method is defined in the base class
+                    . "<input ".$this->getAttributes( $_aInputAttributes )." />" // this method is defined in the base class
                     . $aField[ 'after_input' ]
                 . "</label>"
             . "</div>"
-            . $aField['after_label'];
+            . $aField[ 'after_label' ];
         
     }
         /**
@@ -288,7 +288,7 @@ 
         private function _getLabelAttributes( array $aField, array $aInputAttributes ) {
             return array(
                 'style' => $aField[ 'label_min_width' ] 
-                    ? "min-width:" . $this->getLengthSanitized( $aField[ 'label_min_width' ] ) . ";" 
+                    ? "min-width:".$this->getLengthSanitized( $aField[ 'label_min_width' ] ).";" 
                     : null,
                 'for'   => $aInputAttributes[ 'id' ],
                 'class' => $aInputAttributes[ 'disabled' ] 
@@ -306,7 +306,7 @@ 
         private function _getLabelContainerAttributes( array $aField ) {           
             return array(
                 'style' => $aField[ 'label_min_width' ] || '0' === ( string ) $aField[ 'label_min_width' ]
-                    ? "min-width:" . $this->getLengthSanitized( $aField[ 'label_min_width' ] ) . ";" 
+                    ? "min-width:".$this->getLengthSanitized( $aField[ 'label_min_width' ] ).";" 
                     : null,
                 'class' => 'admin-page-framework-input-label-container'
                     . ' admin-page-framework-input-button-container'
@@ -357,7 +357,7 @@ 
     protected function _getExtraInputFields( &$aField ) {
         
         $_aOutput   = array();
-        $_aOutput[] = $this->getHTMLTag( 
+        $_aOutput[ ] = $this->getHTMLTag( 
             'input',
             array(
                 'type'  => 'hidden',
@@ -365,7 +365,7 @@ 
                 'value' => $aField[ 'input_id' ],
             )
         );
-        $_aOutput[] = $this->getHTMLTag( 
+        $_aOutput[ ] = $this->getHTMLTag( 
             'input',
             array(
                 'type'  => 'hidden',
@@ -373,7 +373,7 @@ 
                 'value' => $aField[ 'field_id' ],
             ) 
         );            
-        $_aOutput[] = $this->getHTMLTag( 
+        $_aOutput[ ] = $this->getHTMLTag( 
             'input',
             array(
                 'type'  => 'hidden',
@@ -381,11 +381,11 @@ 
                 'value' => $aField[ '_input_name_flat' ],
             ) 
         );         
-        $_aOutput[] = $this->_getHiddenInput_SectionID( $aField );
-        $_aOutput[] = $this->_getHiddenInputByKey( $aField, 'redirect_url' );       
-        $_aOutput[] = $this->_getHiddenInputByKey( $aField, 'href' );       
-        $_aOutput[] = $this->_getHiddenInput_Reset( $aField );
-        $_aOutput[] = $this->_getHiddenInput_Email( $aField );
+        $_aOutput[ ] = $this->_getHiddenInput_SectionID( $aField );
+        $_aOutput[ ] = $this->_getHiddenInputByKey( $aField, 'redirect_url' );       
+        $_aOutput[ ] = $this->_getHiddenInputByKey( $aField, 'href' );       
+        $_aOutput[ ] = $this->_getHiddenInput_Reset( $aField );
+        $_aOutput[ ] = $this->_getHiddenInput_Email( $aField );
         return implode( PHP_EOL, array_filter( $_aOutput ) );  
         
     }
@@ -401,9 +401,9 @@ 
                 'input',
                 array(
                     'type'  => 'hidden',
-                    'name'  => "__submit[{$aField['input_id']}][section_id]",
-                    'value' => isset( $aField['section_id'] ) && '_default' !== $aField['section_id'] 
-                        ? $aField['section_id'] 
+                    'name'  => "__submit[{$aField[ 'input_id' ]}][section_id]",
+                    'value' => isset( $aField[ 'section_id' ] ) && '_default' !== $aField[ 'section_id' ] 
+                        ? $aField[ 'section_id' ] 
                         : '',
                 ) 
             );                  
@@ -421,7 +421,7 @@ 
                     'input',
                     array(
                         'type'  => 'hidden',
-                        'name'  => "__submit[{$aField['input_id']}][{$sKey}]",
+                        'name'  => "__submit[{$aField[ 'input_id' ]}][{$sKey}]",
                         'value' => $aField[ $sKey ],
                     ) 
                 )
@@ -435,15 +435,15 @@ 
          * @return      string      the HTML input tag output for the 'reset' argument.
          */        
         private function _getHiddenInput_Reset( array $aField ) {
-            if ( ! $aField['reset'] ) {
+            if ( !$aField[ 'reset' ] ) {
                 return '';
             }
-            return ! $this->_checkConfirmationDisplayed( $aField, $aField[ '_input_name_flat' ], 'reset' )
+            return !$this->_checkConfirmationDisplayed( $aField, $aField[ '_input_name_flat' ], 'reset' )
                 ? $this->getHTMLTag( 
                     'input',
                     array(
                         'type'  => 'hidden',
-                        'name'  => "__submit[{$aField['input_id']}][is_reset]",
+                        'name'  => "__submit[{$aField[ 'input_id' ]}][is_reset]",
                         'value' => '1',
                     ) 
                 )
@@ -451,10 +451,10 @@ 
                     'input',
                     array(
                         'type'  => 'hidden',
-                        'name'  => "__submit[{$aField['input_id']}][reset_key]",
-                        'value' => is_array( $aField['reset'] )   // set the option array key to delete.
-                            ? implode( '|', $aField['reset'] )
-                            : $aField['reset'],
+                        'name'  => "__submit[{$aField[ 'input_id' ]}][reset_key]",
+                        'value' => is_array( $aField[ 'reset' ] )   // set the option array key to delete.
+                            ? implode( '|', $aField[ 'reset' ] )
+                            : $aField[ 'reset' ],
                     )
                 );      
         }
@@ -471,10 +471,10 @@ 
                 return '';
             }
             $this->setTransient( 
-                'apf_em_' . md5( $aField[ '_input_name_flat' ] . get_current_user_id() ), 
+                'apf_em_'.md5( $aField[ '_input_name_flat' ].get_current_user_id() ), 
                 $aField[ 'email' ] 
             );
-            return ! $this->_checkConfirmationDisplayed( $aField, $aField[ '_input_name_flat' ], 'email' )
+            return !$this->_checkConfirmationDisplayed( $aField, $aField[ '_input_name_flat' ], 'email' )
                 ? $this->getHTMLTag( 
                     'input',
                     array(
@@ -499,19 +499,19 @@ 
          * @return      boolean
          * @internal
          */
-        private function _checkConfirmationDisplayed( $aField, $sFlatFieldName, $sType='reset' ) {
+        private function _checkConfirmationDisplayed( $aField, $sFlatFieldName, $sType = 'reset' ) {
                             
-            switch( $sType ) {
+            switch ( $sType ) {
                 default:
                 case 'reset':       // admin page framework _ reset confirmation
-                    $_sTransientKey = 'apf_rc_' . md5( $sFlatFieldName . get_current_user_id() );
+                    $_sTransientKey = 'apf_rc_'.md5( $sFlatFieldName.get_current_user_id() );
                     break;
                 case 'email':       // admin page framework _ email confirmation
-                    $_sTransientKey = 'apf_ec_' . md5( $sFlatFieldName . get_current_user_id() );   
+                    $_sTransientKey = 'apf_ec_'.md5( $sFlatFieldName.get_current_user_id() );   
                     break;
             }
             
-            $_bConfirmed = false === $this->getTransient( $_sTransientKey ) && ! $aField[ 'skip_confirmation' ]
+            $_bConfirmed = false === $this->getTransient( $_sTransientKey ) && !$aField[ 'skip_confirmation' ]
                 ? false
                 : true;
             

Braces +5 added lines, -5 removed lines

@@ -303,7 +303,7 @@ 
          * @return      array       The label container attribute array.
          * @internal
          */        
-        private function _getLabelContainerAttributes( array $aField ) {           
+        private function _getLabelContainerAttributes( array $aField ) {
             return array(
                 'style' => $aField[ 'label_min_width' ] || '0' === ( string ) $aField[ 'label_min_width' ]
                     ? "min-width:" . $this->getLengthSanitized( $aField[ 'label_min_width' ] ) . ";" 
@@ -539,19 +539,19 @@ 
      * @since       2.1.5       Moved from `AdminPageFramwrork_InputField`. Changed the scope to protected from private. Removed the second parameter.
      * @internal
      */ 
-    protected function _getInputFieldValueFromLabel( $aField ) {    
+    protected function _getInputFieldValueFromLabel( $aField ) {
         
         // If the value key is explicitly set, use it. But the empty string will be ignored.
-        if ( isset( $aField[ 'value' ] ) && $aField[ 'value' ] != '' ) { 
+        if ( isset( $aField[ 'value' ] ) && $aField[ 'value' ] != '' ) {
             return $aField[ 'value' ]; 
         }
         
-        if ( isset( $aField[ 'label' ] ) ) { 
+        if ( isset( $aField[ 'label' ] ) ) {
             return $aField[ 'label' ]; 
         }
         
         // If the default value is set,
-        if ( isset( $aField[ 'default' ] ) ) { 
+        if ( isset( $aField[ 'default' ] ) ) {
             return $aField[ 'default' ]; 
         }