michaeluno / admin-page-framework

development/factory/_common/_abstract/AdminPageFramework_Factory_Controller.php

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 +7 added lines, -7 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 );
     }
 
@@ -177,7 +177,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 );
         }
@@ -213,7 +213,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 );
         }
 
@@ -299,7 +299,7 @@ 
      */
     public function addSettingSection( $aSectionset ) {
 
-        if ( ! is_array( $aSectionset ) ) {
+        if ( !is_array( $aSectionset ) ) {
             return;
         }
 
@@ -332,7 +332,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 );
         }
     }
@@ -607,7 +607,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,
@@ -626,7 +626,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/_abstract/AdminPageFramework_Factory_View.php

Spacing +12 added lines, -12 removed lines

@@ -40,7 +40,7 @@ 
          * @return      string      the input id attribute
          */
         public function _replyToGetSectionName( /* $sSectionName, $aSectionset */ ) {
-            $_aParams = func_get_args() + array( null, null, );
+            $_aParams = func_get_args() + array( null, null,);
             return $_aParams[ 0 ];
         }
 
@@ -68,8 +68,8 @@ 
          * @since       3.6.0
          * @return      string
          */
-        public function _replyToGetFieldNameAttribute( /* $sFieldName, $aFieldset */ )  {
-            $_aParams = func_get_args() + array( null, null, );
+        public function _replyToGetFieldNameAttribute( /* $sFieldName, $aFieldset */ ) {
+            $_aParams = func_get_args() + array( null, null,);
             return $_aParams[ 0 ];
         }
         /**
@@ -79,7 +79,7 @@ 
          * @return      string
          */
         public function _replyToGetFlatFieldName( /* $sFieldName, $aFieldset */ ) {
-            $_aParams = func_get_args() + array( null, null, );
+            $_aParams = func_get_args() + array( null, null,);
             return $_aParams[ 0 ];
         }
 
@@ -101,7 +101,7 @@ 
          * @return      string      the flat input name attribute
          */
         public function _replyToGetFlatInputName( /* $sFlatNameAttribute, $aField, $sKey */ ) {
-            $_aParams   = func_get_args() + array( null, null, null );
+            $_aParams = func_get_args() + array( null, null, null );
             return $_aParams[ 0 ];
         }
 
@@ -143,14 +143,14 @@ 
                 'if'            => true,
                 'capability'    => '',
             );
-            if ( ! $aElementDefinition[ 'if' ] ) {
+            if ( !$aElementDefinition[ 'if' ] ) {
                 return false;
             }
             // For front-end forms that allow guests, the capability level can be empty. In that case, return true.
-            if ( ! $aElementDefinition[ 'capability' ] ) {
+            if ( !$aElementDefinition[ 'capability' ] ) {
                 return true;
             }
-            if ( ! current_user_can( $aElementDefinition[ 'capability' ] ) ) {
+            if ( !current_user_can( $aElementDefinition[ 'capability' ] ) ) {
                 return false;
             }
             return $bDefault;
@@ -186,7 +186,7 @@ 
             $this,
             array(
                 // section_{instantiated class name}_{section id}
-                'section_head_' . $this->oProp->sClassName . '_' . $aSectionset[ 'section_id' ]
+                'section_head_'.$this->oProp->sClassName.'_'.$aSectionset[ 'section_id' ]
             ),
             $sSectionDescription
         );
@@ -203,15 +203,15 @@ 
      */
     public function _replyToGetFieldOutput( $sFieldOutput, $aFieldset ) {
 
-        $_sSectionPart  = $this->oUtil->getAOrB(
+        $_sSectionPart = $this->oUtil->getAOrB(
             isset( $aFieldset[ 'section_id' ] ) && '_default' !== $aFieldset[ 'section_id' ],
-            '_' . $aFieldset[ 'section_id' ],
+            '_'.$aFieldset[ 'section_id' ],
             ''
         );
         return $this->oUtil->addAndApplyFilters(
             $this,
             array(
-                'field_' . $this->oProp->sClassName . $_sSectionPart . '_' . $aFieldset[ 'field_id' ]
+                'field_'.$this->oProp->sClassName.$_sSectionPart.'_'.$aFieldset[ 'field_id' ]
             ),
             $sFieldOutput,
             $aFieldset // the field array

Braces +1 added lines, -1 removed lines

@@ -68,7 +68,7 @@
          * @since       3.6.0
          * @return      string
          */
-        public function _replyToGetFieldNameAttribute( /* $sFieldName, $aFieldset */ )  {
+        public function _replyToGetFieldNameAttribute( /* $sFieldName, $aFieldset */ ) {
             $_aParams = func_get_args() + array( null, null, );
             return $_aParams[ 0 ];
         }

development/factory/_common/_abstract/_view/AdminPageFramework_Factory_View__SettingNotice.php

Spacing +3 added lines, -3 removed lines

@@ -26,7 +26,7 @@ 
      * @since       3.7.9       Added the second parameter to accept an action hook name.
      */
 
-    public function __construct( $oFactory, $sActionHookName='admin_notices' ) {
+    public function __construct( $oFactory, $sActionHookName = 'admin_notices' ) {
 
         $this->oFactory = $oFactory;
 
@@ -45,7 +45,7 @@ 
      */
     public function _replyToPrintSettingNotice() {
 
-        if ( ! $this->_shouldProceed() ) {
+        if ( !$this->_shouldProceed() ) {
             return;
         }
         $this->oFactory->oForm->printSubmitNotices();
@@ -59,7 +59,7 @@ 
          */
         private function _shouldProceed() {
 
-            if ( ! $this->oFactory->isInThePage() ) {
+            if ( !$this->oFactory->isInThePage() ) {
                 return false;
             }
 

development/factory/_common/_abstract/_view/AdminPageFramework_TabNavigationBar.php

Spacing +14 added lines, -14 removed lines

@@ -25,7 +25,7 @@ 
     /**
      * Stores the tab items.
      */
-    public $aTabs   = array();
+    public $aTabs = array();
 
     /**
      * Stores container attributes.
@@ -35,11 +35,11 @@ 
     );
 
     public $aTab = array(
-        'slug'       => null,  // (string) tab slug (id)
-        'title'      => null,  // (string) tab title
-        'href'       => null,  // (string) link url
-        'disabled'   => null,  // (boolean)
-        'class'      => null,  // (string) class selector to append to the class attribute
+        'slug'       => null, // (string) tab slug (id)
+        'title'      => null, // (string) tab title
+        'href'       => null, // (string) link url
+        'disabled'   => null, // (boolean)
+        'class'      => null, // (string) class selector to append to the class attribute
         'attributes' => array(),
     );
 
@@ -58,11 +58,11 @@ 
      * @param       array             $aTabs              An array holding each tab definitions
      * @param       array|string      $asActiveTabSlugs   The default tab slug.
      */
-    public function __construct( array $aTabs, $asActiveTabSlugs, $sTabTag='h2', $aAttributes=array( 'class' => 'nav-tab-wrapper', ), $aCallbacks=array() ) {
+    public function __construct( array $aTabs, $asActiveTabSlugs, $sTabTag = 'h2', $aAttributes = array( 'class' => 'nav-tab-wrapper',), $aCallbacks = array() ) {
 
-        $this->aCallbacks           = $aCallbacks + array(
+        $this->aCallbacks = $aCallbacks + array(
             'format'    => null,
-            'arguments' => null,  // custom arguments to pass to the callback functions.
+            'arguments' => null, // custom arguments to pass to the callback functions.
         );
         $this->aTabs                = $this->_getFormattedTabs( $aTabs );
         $this->aActiveSlugs         = $this->getAsArray( $asActiveTabSlugs );
@@ -76,7 +76,7 @@ 
          * @return      array
          */
         private function _getFormattedTabs( array $aTabs ) {
-            foreach( $aTabs as $_isKey => &$_aTab ) {
+            foreach ( $aTabs as $_isKey => &$_aTab ) {
                 $_aFormattedTab = $this->_getFormattedTab( $_aTab, $aTabs );
                 if ( isset( $_aFormattedTab[ 'slug' ] ) ) {
                     $_aTab = $_aFormattedTab;
@@ -127,12 +127,12 @@ 
         private function _getTabs() {
 
             $_aOutput = array();
-            foreach( $this->aTabs as $_aTab ) {
+            foreach ( $this->aTabs as $_aTab ) {
                 $_sTab = $this->_getTab( $_aTab );
-                if ( ! $_sTab ) {
+                if ( !$_sTab ) {
                     continue;
                 }
-                $_aOutput[] = $_sTab;
+                $_aOutput[ ] = $_sTab;
             }
 
             $_aContainerAttributes = $this->aAttributes + array( 'class' => null );
@@ -143,7 +143,7 @@ 
 
             return empty( $_aOutput )
                 ? ''
-                : "<{$this->sTabTag} " . $this->getAttributes( $_aContainerAttributes ) . ">"
+                : "<{$this->sTabTag} ".$this->getAttributes( $_aContainerAttributes ).">"
                     . implode( '', $_aOutput )
                 . "</{$this->sTabTag}>";
 

development/factory/_common/_abstract/_view/AdminPageFramework_Factory___Script_Base.php

Spacing +3 added lines, -3 removed lines

@@ -28,7 +28,7 @@ 
      *
      * @since       3.3.0
      */
-    public function __construct( $oMsg=null ) {
+    public function __construct( $oMsg = null ) {
 
         if ( $this->hasBeenCalled( get_class( $this ) ) ) {
             return;
@@ -87,10 +87,10 @@ 
      */
     public function _replyToPrintScript() {
         $_sScript = $this->getScript( $this->oMsg );
-        if ( ! $_sScript ) {
+        if ( !$_sScript ) {
             return;
         }
-        echo "<script type='text/javascript' class='" . strtolower( get_class( $this ) ) . "'>"
+        echo "<script type='text/javascript' class='".strtolower( get_class( $this ) )."'>"
                 . '/* <![CDATA[ */'
                 . $_sScript
                 . '/* ]]> */'

development/factory/meta_box/AdminPageFramework_MetaBox_View.php

Spacing +3 added lines, -3 removed lines

@@ -30,7 +30,7 @@ 
 
         // Use nonce for verification
         $_aOutput   = array();
-        $_aOutput[] = wp_nonce_field(
+        $_aOutput[ ] = wp_nonce_field(
             $this->oProp->sMetaBoxID,
             $this->oProp->sMetaBoxID,
             true,
@@ -39,11 +39,11 @@ 
 
         // Get the fields output. If no field is added, the form object is not instantiated.
         if ( isset( $this->oForm ) ) {
-            $_aOutput[] = $this->oForm->get();
+            $_aOutput[ ] = $this->oForm->get();
         }
 
         // Do actions
-        $this->oUtil->addAndDoActions( $this, 'do_' . $this->oProp->sClassName, $this );
+        $this->oUtil->addAndDoActions( $this, 'do_'.$this->oProp->sClassName, $this );
 
         // Render the filtered output.
         echo $this->oUtil->addAndApplyFilters(

development/factory/meta_box/AdminPageFramework_MetaBox_Controller.php

Indentation +26 added lines, -26 removed lines

@@ -17,32 +17,32 @@
 abstract class AdminPageFramework_MetaBox_Controller extends AdminPageFramework_MetaBox_View {
 
     /**
-    * The method for all necessary set-ups.
-    *
-    * <h4>Example</h4>
-    * <code> public function setUp() {
-    *     $this->addSettingFields(
-    *         array(
-    *             'field_id'    => 'sample_metabox_text_field',
-    *             'title'       => 'Text Input',
-    *             'description' => 'The description for the field.',
-    *             'type'        => 'text',
-    *         ),
-    *         array(
-    *             'field_id'    => 'sample_metabox_textarea_field',
-    *             'title'       => 'Textarea',
-    *             'description' => 'The description for the field.',
-    *             'type'        => 'textarea',
-    *             'default'     => 'This is a default text value.',
-    *         )
-    *     );
-    * }</code>
-    *
-    * @abstract
-    * @since        2.0.0
-    * @remark       The user should override this method.
-    * @return       void
-    */
+     * The method for all necessary set-ups.
+     *
+     * <h4>Example</h4>
+     * <code> public function setUp() {
+     *     $this->addSettingFields(
+     *         array(
+     *             'field_id'    => 'sample_metabox_text_field',
+     *             'title'       => 'Text Input',
+     *             'description' => 'The description for the field.',
+     *             'type'        => 'text',
+     *         ),
+     *         array(
+     *             'field_id'    => 'sample_metabox_textarea_field',
+     *             'title'       => 'Textarea',
+     *             'description' => 'The description for the field.',
+     *             'type'        => 'textarea',
+     *             'default'     => 'This is a default text value.',
+     *         )
+     *     );
+     * }</code>
+     *
+     * @abstract
+     * @since        2.0.0
+     * @remark       The user should override this method.
+     * @return       void
+     */
     public function setUp() {}
 
     /**

development/factory/meta_box/AdminPageFramework_MetaBox_Router.php

Spacing +9 added lines, -9 removed lines

@@ -33,7 +33,7 @@ 
      * @param       string          $sTextDomain            (optional) The text domain applied to the displayed text messages. Default: `admin-page-framework`.
      * @return      void
      */
-    public function __construct( $sMetaBoxID, $sTitle, $asPostTypeOrScreenID=array( 'post' ), $sContext='normal', $sPriority='default', $sCapability='edit_posts', $sTextDomain='admin-page-framework' ) {
+    public function __construct( $sMetaBoxID, $sTitle, $asPostTypeOrScreenID = array( 'post' ), $sContext = 'normal', $sPriority = 'default', $sCapability = 'edit_posts', $sTextDomain = 'admin-page-framework' ) {
 
         parent::__construct( $this->oProp );
 
@@ -41,15 +41,15 @@ 
             ? $this->oUtil->sanitizeSlug( $sMetaBoxID )
             : strtolower( $this->oProp->sClassName );
         $this->oProp->sTitle        = $sTitle;
-        $this->oProp->sContext      = $sContext;    // 'normal', 'advanced', or 'side'
-        $this->oProp->sPriority     = $sPriority;   // 'high', 'core', 'default' or 'low'
+        $this->oProp->sContext      = $sContext; // 'normal', 'advanced', or 'side'
+        $this->oProp->sPriority     = $sPriority; // 'high', 'core', 'default' or 'low'
 
-        if ( ! $this->oProp->bIsAdmin ) {
+        if ( !$this->oProp->bIsAdmin ) {
             return;
         }
 
         // 3.8.14
-        add_action( 'set_up_' . $this->oProp->sClassName, array( $this, '_replyToCallLoadMethods' ), 100 );
+        add_action( 'set_up_'.$this->oProp->sClassName, array( $this, '_replyToCallLoadMethods' ), 100 );
 
         $this->oUtil->registerAction(
             $this->oProp->bIsAdminAjax
@@ -86,11 +86,11 @@ 
             return true;
         }
 
-        if ( ! in_array( $this->oProp->sPageNow, array( 'post.php', 'post-new.php' ) ) ) {
+        if ( !in_array( $this->oProp->sPageNow, array( 'post.php', 'post-new.php' ) ) ) {
             return false;
         }
 
-        if ( ! in_array( $this->oUtil->getCurrentPostType(), $this->oProp->aPostTypes ) ) {
+        if ( !in_array( $this->oUtil->getCurrentPostType(), $this->oProp->aPostTypes ) ) {
             return false;
         }
         return true;
@@ -105,14 +105,14 @@ 
      */
     protected function _isValidAjaxReferrer() {
 
-        if ( ! $this->oProp->bIsAdminAjax ) {
+        if ( !$this->oProp->bIsAdminAjax ) {
             return false;
         }
         $_aReferrer = parse_url( $this->oProp->sAjaxReferrer ) + array( 'query' => '', 'path' => '' );
         parse_str( $_aReferrer[ 'query' ], $_aQuery );
 
         $_sBaseName = basename( $_aReferrer[ 'path' ] );
-        if ( ! in_array( $_sBaseName, array( 'post.php', 'post-new.php' ) ) ) {
+        if ( !in_array( $_sBaseName, array( 'post.php', 'post-new.php' ) ) ) {
             return false;
         }
         // post-new.php?post_type={...} or post.php?post={n}&action=edit

development/factory/meta_box/_model/AdminPageFramework_Property_post_meta_box.php

Spacing +7 added lines, -7 removed lines

@@ -34,7 +34,7 @@ 
      * @since       2.1.0       Moved from the meta box class.
      * @var string
      */
-    public $sMetaBoxID ='';
+    public $sMetaBoxID = '';
 
     /**
      * Stores the post type slugs associated with the meta box.
@@ -137,14 +137,14 @@ 
     /**
      * Calls the parent constructor by formatting the parameter values.
      */
-    public function __construct( $oCaller, $sClassName, $sCapability='edit_posts', $sTextDomain='admin-page-framework', $sStructureType='post_meta_box' ) {
+    public function __construct( $oCaller, $sClassName, $sCapability = 'edit_posts', $sTextDomain = 'admin-page-framework', $sStructureType = 'post_meta_box' ) {
 
         parent::__construct(
-            $oCaller,           // caller object
-            null,               // caller script path - meta boxes don't need the caller script path.
-            $sClassName,        // class name
-            $sCapability,       // capability
-            $sTextDomain,       // text domain
+            $oCaller, // caller object
+            null, // caller script path - meta boxes don't need the caller script path.
+            $sClassName, // class name
+            $sCapability, // capability
+            $sTextDomain, // text domain
             $sStructureType     // structure type
         );