michaeluno / admin-page-framework

development/factory/admin_page/AdminPageFramework_Controller_Menu.php

Doc Comments +3 added lines, -3 removed lines

@@ -74,6 +74,8 @@ 
      *  <li>a base64-encoded SVG using a data URI, which will be colored to match the color scheme. This should begin with 'data:image/svg+xml;base64,'.</li>
      * </ul>
      * @param       string      (optional) the position number that is passed to the <var>$position</var> parameter of the <a href="http://codex.wordpress.org/Function_Reference/add_menu_page">add_menu_page()</a> function.
+     * @param string $sIcon16x16
+     * @param integer $iMenuPosition
      * @return      void
      */
     public function setRootMenuPage( $sRootMenuLabel, $sIcon16x16=null, $iMenuPosition=null ) {
@@ -96,6 +98,7 @@ 
          * 
          * @since       2.0.0
          * @internal
+         * @param string $sMenuLabel
          * @return      void|string     Returns the associated slug string, if true.
          */ 
         private function _isBuiltInMenuItem( $sMenuLabel ) {
@@ -160,9 +163,6 @@ 
      * @since        3.0.0       Changed the scope to public.
      * @remark       The sub menu page slug should be unique because add_submenu_page() can add one callback per page slug.
      * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-     * @param        array       $aSubMenuItem1      a first sub-menu array. A sub-menu array can be a link or a page. For the specifications of the array structures and its arguments, refer to the parameter section of the `addSubMenuItem()` method.
-     * @param        array       $aSubMenuItem2      (optional) a second sub-menu array.
-     * @param        array       $_and_more          (optional) a third and add items as many as necessary with next parameters.
      * @access       public
      * @return       void
      */     

Indentation +14 added lines, -14 removed lines

@@ -250,20 +250,20 @@
     }
 
     /**
-    * Adds the given link into the menu on the left sidebar of the administration panel.
-    * 
-    * @since        2.0.0
-    * @since        3.0.0       Changed the scope to public from protected.
-    * @since        3.5.0       Changed the scope to public as it was still protected.
-    * @param        string      the menu title.
-    * @param        string      the URL linked to the menu.
-    * @param        string      (optional) the <a href="http://codex.wordpress.org/Roles_and_Capabilities" target="_blank">access level</a>.
-    * @param        string      (optional) the order number. The larger it is, the lower the position it gets.
-    * @param        string      (optional) if set to false, the menu title will not be listed in the tab navigation menu at the top of the page.
-    * @access       public
-    * @return       void
-    * @internal
-    */    
+     * Adds the given link into the menu on the left sidebar of the administration panel.
+     * 
+     * @since        2.0.0
+     * @since        3.0.0       Changed the scope to public from protected.
+     * @since        3.5.0       Changed the scope to public as it was still protected.
+     * @param        string      the menu title.
+     * @param        string      the URL linked to the menu.
+     * @param        string      (optional) the <a href="http://codex.wordpress.org/Roles_and_Capabilities" target="_blank">access level</a>.
+     * @param        string      (optional) the order number. The larger it is, the lower the position it gets.
+     * @param        string      (optional) if set to false, the menu title will not be listed in the tab navigation menu at the top of the page.
+     * @access       public
+     * @return       void
+     * @internal
+     */    
     public function addSubMenuLink( array $aSubMenuLink ) {
         
         // If required keys are not set, return.

Spacing +6 added lines, -6 removed lines

@@ -76,7 +76,7 @@ 
      * @param       string      (optional) the position number that is passed to the <var>$position</var> parameter of the <a href="http://codex.wordpress.org/Function_Reference/add_menu_page">add_menu_page()</a> function.
      * @return      void
      */
-    public function setRootMenuPage( $sRootMenuLabel, $sIcon16x16=null, $iMenuPosition=null ) {
+    public function setRootMenuPage( $sRootMenuLabel, $sIcon16x16 = null, $iMenuPosition = null ) {
 
         $sRootMenuLabel = trim( $sRootMenuLabel );
         $_sSlug         = $this->_isBuiltInMenuItem( $sRootMenuLabel ); // if true, this method returns the slug
@@ -267,16 +267,16 @@ 
     public function addSubMenuLink( array $aSubMenuLink ) {
         
         // If required keys are not set, return.
-        if ( ! isset( $aSubMenuLink[ 'href' ], $aSubMenuLink[ 'title' ] ) ) { 
+        if ( !isset( $aSubMenuLink[ 'href' ], $aSubMenuLink[ 'title' ] ) ) { 
             return; 
         }
         
         // If the set URL is not valid, return.
-        if ( ! filter_var( $aSubMenuLink[ 'href' ], FILTER_VALIDATE_URL ) ) { 
+        if ( !filter_var( $aSubMenuLink[ 'href' ], FILTER_VALIDATE_URL ) ) { 
             return; 
         }
 
-        $_oFormatter   = new AdminPageFramework_Format_SubMenuLink( 
+        $_oFormatter = new AdminPageFramework_Format_SubMenuLink( 
             $aSubMenuLink, 
             $this,
             count( $this->oProp->aPages ) + 1
@@ -334,11 +334,11 @@ 
      */ 
     public function addSubMenuPage( array $aSubMenuPage ) {
 
-        if ( ! isset( $aSubMenuPage[ 'page_slug' ] ) ) { 
+        if ( !isset( $aSubMenuPage[ 'page_slug' ] ) ) { 
             return; 
         }
             
-        $_oFormatter   = new AdminPageFramework_Format_SubMenuPage( 
+        $_oFormatter = new AdminPageFramework_Format_SubMenuPage( 
             $aSubMenuPage,
             $this,
             count( $this->oProp->aPages ) + 1

Braces +3 added lines, -3 removed lines

@@ -267,12 +267,12 @@ 
     public function addSubMenuLink( array $aSubMenuLink ) {
         
         // If required keys are not set, return.
-        if ( ! isset( $aSubMenuLink[ 'href' ], $aSubMenuLink[ 'title' ] ) ) { 
+        if ( ! isset( $aSubMenuLink[ 'href' ], $aSubMenuLink[ 'title' ] ) ) {
             return; 
         }
         
         // If the set URL is not valid, return.
-        if ( ! filter_var( $aSubMenuLink[ 'href' ], FILTER_VALIDATE_URL ) ) { 
+        if ( ! filter_var( $aSubMenuLink[ 'href' ], FILTER_VALIDATE_URL ) ) {
             return; 
         }
 
@@ -334,7 +334,7 @@ 
      */ 
     public function addSubMenuPage( array $aSubMenuPage ) {
 
-        if ( ! isset( $aSubMenuPage[ 'page_slug' ] ) ) { 
+        if ( ! isset( $aSubMenuPage[ 'page_slug' ] ) ) {
             return; 
         }
             

development/admin-page-framework.php

Spacing +10 added lines, -10 removed lines

@@ -10,7 +10,7 @@ 
  * @package     AdminPageFramework
  */
 
-if ( ! class_exists( 'AdminPageFramework_Registry', false ) ) :
+if ( !class_exists( 'AdminPageFramework_Registry', false ) ) :
 /**
  * Facilitates WordPress plugin and theme development.
  *
@@ -61,7 +61,7 @@ 
 final class AdminPageFramework_Registry extends AdminPageFramework_Registry_Base {
 
     const TEXT_DOMAIN        = 'admin-page-framework';
-    const TEXT_DOMAIN_PATH   = '/language';  // not used at the moment
+    const TEXT_DOMAIN_PATH   = '/language'; // not used at the moment
 
     /**
      * Indicates whether the framework is loaded from the minified version or not.
@@ -103,11 +103,11 @@ 
      * Sets up static properties.
      * @return      void
      */
-    static public function setUp( $sFilePath=__FILE__ ) {
+    static public function setUp( $sFilePath = __FILE__ ) {
 
         self::$sFilePath                = $sFilePath;
         self::$sDirPath                 = dirname( self::$sFilePath );
-        self::$sIncludeClassListPath    = self::$sDirPath . '/admin-page-framework-include-class-list.php';
+        self::$sIncludeClassListPath    = self::$sDirPath.'/admin-page-framework-include-class-list.php';
         self::$aClassFiles              = self::_getClassFilePathList( self::$sIncludeClassListPath );
         self::$sAutoLoaderPath          = isset( self::$aClassFiles[ 'AdminPageFramework_RegisterClasses' ] )
             ? self::$aClassFiles[ 'AdminPageFramework_RegisterClasses' ]
@@ -122,7 +122,7 @@ 
          * @return      array
          */
         static private function _getClassFilePathList( $sInclusionClassListPath ) {
-            $aClassFiles = array();    // this will be updated if the inclusion below is successful.
+            $aClassFiles = array(); // this will be updated if the inclusion below is successful.
             include( $sInclusionClassListPath );
             return $aClassFiles;
         }
@@ -135,11 +135,11 @@ 
      */
     static public function getVersion() {
 
-        if ( ! isset( self::$sAutoLoaderPath ) ) {
-            trigger_error( self::NAME . ': ' . ' : ' . sprintf( __( 'The method is called too early. Perform <code>%2$s</code> earlier.', 'admin-page-framework' ), __METHOD__, 'setUp()' ), E_USER_WARNING );
+        if ( !isset( self::$sAutoLoaderPath ) ) {
+            trigger_error( self::NAME.': '.' : '.sprintf( __( 'The method is called too early. Perform <code>%2$s</code> earlier.', 'admin-page-framework' ), __METHOD__, 'setUp()' ), E_USER_WARNING );
             return self::VERSION;
         }
-        $_aMinifiedVesionSuffix     = array(
+        $_aMinifiedVesionSuffix = array(
             0 => '',
             1 => '.min',
         );
@@ -168,7 +168,7 @@ 
 }
 endif;
 
-if ( ! class_exists( 'AdminPageFramework_Bootstrap', false ) ) :
+if ( !class_exists( 'AdminPageFramework_Bootstrap', false ) ) :
 /**
  * Loads the Admin Page Framework library.
  *
@@ -189,7 +189,7 @@ 
      */
     public function __construct( $sLibraryPath ) {
 
-        if ( ! $this->_isLoadable() ) {
+        if ( !$this->_isLoadable() ) {
             return;
         }
 

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

Indentation +1 added lines, -1 removed lines

@@ -158,7 +158,7 @@
                                     . $this->getFrameworkNameVersion()
                                     . '  ('
                                         . $this->oMsg->get( 'debug_info_will_be_disabled' )
-                                      . ')'
+                                        . ')'
                                 . '</span>',
                             'attributes'    => array(
                                 'container' => array(

Spacing +14 added lines, -14 removed lines

@@ -17,14 +17,14 @@ 
  */
 class AdminPageFramework_Form_View___SectionTitle extends AdminPageFramework_Form_View___Section_Base {            
   
-    public $aArguments      = array(
+    public $aArguments = array(
         'title'         => null,
         'tag'           => null,
         'section_index' => null,
         
         'sectionset'    => array(),
     );
-    public $aFieldsets               = array();
+    public $aFieldsets = array();
     public $aSavedData              = array();
     public $aFieldErrors            = array();
     public $aFieldTypeDefinitions   = array();
@@ -90,7 +90,7 @@ 
          * @since       3.7.0      Moved from `AdminPageFramework_FormPart_SectionTitle`.
          * @return      string      The section title output. 
          */
-        protected function _getSectionTitle( $sTitle, $sTag, $aFieldsets, $iSectionIndex=null, $aFieldTypeDefinitions=array(), $aCollapsible=array() ) {
+        protected function _getSectionTitle( $sTitle, $sTag, $aFieldsets, $iSectionIndex = null, $aFieldTypeDefinitions = array(), $aCollapsible = array() ) {
 
             $_aSectionTitleFieldset = $this->_getSectionTitleField( $aFieldsets, $iSectionIndex, $aFieldTypeDefinitions );
             $_sFieldsInSectionTitle = $this->_getFieldsetsOutputInSectionTitleArea( $aFieldsets, $iSectionIndex, $aFieldTypeDefinitions );
@@ -100,7 +100,7 @@ 
             $_bHasOtherFields       = $_sFieldsInSectionTitle
                 ? ' has-fields'
                 : '';
-            $_sOutput               = $_sTitle . $_sFieldsInSectionTitle;
+            $_sOutput               = $_sTitle.$_sFieldsInSectionTitle;
             return $_sOutput
                 ? "<div class='section-title-height-fixer'></div>"
                 . "<div class='section-title-outer-container'>" // 3.8.13+ For vertical alignment
@@ -132,7 +132,7 @@ 
                  * @return      string
                  */
                 private function _getToolTip( $_aSectionset ) {
-                    $_sSectionTitleTagID = str_replace( '|', '_', $_aSectionset[ '_section_path' ]  ) . '_' . $this->aArguments[ 'section_index' ];
+                    $_sSectionTitleTagID = str_replace( '|', '_', $_aSectionset[ '_section_path' ] ).'_'.$this->aArguments[ 'section_index' ];
                     $_oToolTip           = new AdminPageFramework_Form_View___ToolTip(
                         $_aSectionset[ 'tip' ],
                         $_sSectionTitleTagID
@@ -147,14 +147,14 @@ 
                  */
                 private function _getDebugInfo( $aSectionset ) {
                                         
-                    if ( ! $aSectionset[ 'show_debug_info' ] ) {
+                    if ( !$aSectionset[ 'show_debug_info' ] ) {
                         return '';
                     }
-                    $_oToolTip           = new AdminPageFramework_Form_View___ToolTip(
+                    $_oToolTip = new AdminPageFramework_Form_View___ToolTip(
                         array(
                             'title'         => $this->oMsg->get( 'section_arguments' ),
                             'dash-icon'     => 'dashicons-info',
-                            'icon_alt_text' => '[' . $this->oMsg->get( 'debug' ) . ' ]',
+                            'icon_alt_text' => '['.$this->oMsg->get( 'debug' ).' ]',
                             'content'       => AdminPageFramework_Debug::getDetails( $aSectionset )
                                 . '<span class="admin-page-framework-info">'
                                     . $this->getFrameworkNameVersion()
@@ -168,7 +168,7 @@ 
                                 ),
                             )
                         ),
-                        $aSectionset[ '_section_path' ] . '_debug'
+                        $aSectionset[ '_section_path' ].'_debug'
                     );            
                     return $_oToolTip->get();                    
                     
@@ -197,8 +197,8 @@ 
             private function _getFieldsetsOutputInSectionTitleArea( array $aFieldsets, $iSectionIndex, $aFieldTypeDefinitions ) {   
 
                 $_sOutput = '';
-                foreach( $this->_getFieldsetsInSectionTitleArea( $aFieldsets, $iSectionIndex, $aFieldTypeDefinitions ) as $_aFieldset ) {
-                    if ( empty( $_aFieldset ) )  {
+                foreach ( $this->_getFieldsetsInSectionTitleArea( $aFieldsets, $iSectionIndex, $aFieldTypeDefinitions ) as $_aFieldset ) {
+                    if ( empty( $_aFieldset ) ) {
                         continue;
                     }
                     $_sOutput .= $this->getFieldsetOutput( $_aFieldset );
@@ -214,7 +214,7 @@ 
                 private function _getFieldsetsInSectionTitleArea( array $aFieldsets, $iSectionIndex, $aFieldTypeDefinitions ) {
                     
                     $_aFieldsetsInSectionTitle = array();
-                    foreach( $aFieldsets as $_aFieldset ) {
+                    foreach ( $aFieldsets as $_aFieldset ) {
                         
                         if ( 'section_title' !== $_aFieldset[ 'placement' ] ) {
                             continue;
@@ -225,7 +225,7 @@ 
                             $iSectionIndex,
                             $aFieldTypeDefinitions
                         );         
-                        $_aFieldsetsInSectionTitle[] = $_oFieldsetOutputFormatter->get();
+                        $_aFieldsetsInSectionTitle[ ] = $_oFieldsetOutputFormatter->get();
                         
                     }
                     return $_aFieldsetsInSectionTitle;
@@ -244,7 +244,7 @@ 
                  */
                 private function _getSectionTitleField( array $aFieldsets, $iSectionIndex, $aFieldTypeDefinitions ) {   
                 
-                    foreach( $aFieldsets as $_aFieldset ) {
+                    foreach ( $aFieldsets as $_aFieldset ) {
                         
                         if ( 'section_title' !== $_aFieldset[ 'type' ] ) {
                             continue;

Braces +4 added lines, -4 removed lines

@@ -15,7 +15,7 @@ 
  * @since       3.7.0      Changed the name from `AdminPageFramework_FormPart_SectionTitle`.
  * @internal
  */
-class AdminPageFramework_Form_View___SectionTitle extends AdminPageFramework_Form_View___Section_Base {            
+class AdminPageFramework_Form_View___SectionTitle extends AdminPageFramework_Form_View___Section_Base {
   
     public $aArguments      = array(
         'title'         => null,
@@ -194,11 +194,11 @@ 
              * @since       3.8.0
              * @internal
              */
-            private function _getFieldsetsOutputInSectionTitleArea( array $aFieldsets, $iSectionIndex, $aFieldTypeDefinitions ) {   
+            private function _getFieldsetsOutputInSectionTitleArea( array $aFieldsets, $iSectionIndex, $aFieldTypeDefinitions ) {
 
                 $_sOutput = '';
                 foreach( $this->_getFieldsetsInSectionTitleArea( $aFieldsets, $iSectionIndex, $aFieldTypeDefinitions ) as $_aFieldset ) {
-                    if ( empty( $_aFieldset ) )  {
+                    if ( empty( $_aFieldset ) ) {
                         continue;
                     }
                     $_sOutput .= $this->getFieldsetOutput( $_aFieldset );
@@ -242,7 +242,7 @@ 
                  * @since       3.7.0       Moved from `AdminPageFramework_FormPart_SectionTitle`.
                  * @return      array|void
                  */
-                private function _getSectionTitleField( array $aFieldsets, $iSectionIndex, $aFieldTypeDefinitions ) {   
+                private function _getSectionTitleField( array $aFieldsets, $iSectionIndex, $aFieldTypeDefinitions ) {
                 
                     foreach( $aFieldsets as $_aFieldset ) {
                         

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

Spacing +38 added lines, -38 removed lines

@@ -29,38 +29,38 @@ 
     static public $aStructure = array(
     
         // Required Keys
-        'field_id'                  => null,    // (string)
-        'section_id'                => null,    // (string)
+        'field_id'                  => null, // (string)
+        'section_id'                => null, // (string)
 
         // Optional Keys        
-        'type'                      => null,    // (string) (3.8.0+ Became okay to omit.)
-        'section_title'             => null,    // This will be assigned automatically in the formatting method.
-        'page_slug'                 => null,    // This will be assigned automatically in the formatting method.
-        'tab_slug'                  => null,    // This will be assigned automatically in the formatting method.
-        'option_key'                => null,    // This will be assigned automatically in the formatting method.
-        'class_name'                => null,    // Stores the instantiated class name. Used by the export field type. Also a third party custom field type uses it.
+        'type'                      => null, // (string) (3.8.0+ Became okay to omit.)
+        'section_title'             => null, // This will be assigned automatically in the formatting method.
+        'page_slug'                 => null, // This will be assigned automatically in the formatting method.
+        'tab_slug'                  => null, // This will be assigned automatically in the formatting method.
+        'option_key'                => null, // This will be assigned automatically in the formatting method.
+        'class_name'                => null, // Stores the instantiated class name. Used by the export field type. Also a third party custom field type uses it.
         'capability'                => null,        
         'title'                     => null,    
         'tip'                       => null,    
         'description'               => null,    
-        'error_message'             => null,    // error message for the field
+        'error_message'             => null, // error message for the field
         'before_label'              => null,    
         'after_label'               => null,    
         'if'                        => true,    
-        'order'                     => null,    // do not set the default number here for this key.     
+        'order'                     => null, // do not set the default number here for this key.     
         'default'                   => null,
         'value'                     => null,
-        'help'                      => null,    // 2.1.0
-        'help_aside'                => null,    // 2.1.0
-        'repeatable'                => null,    // 2.1.3
-        'sortable'                  => null,    // 2.1.3
-        'show_title_column'         => true,    // 3.0.0
-        'hidden'                    => null,    // 3.0.0
+        'help'                      => null, // 2.1.0
+        'help_aside'                => null, // 2.1.0
+        'repeatable'                => null, // 2.1.3
+        'sortable'                  => null, // 2.1.3
+        'show_title_column'         => true, // 3.0.0
+        'hidden'                    => null, // 3.0.0
         
-        'placement'                 => 'normal',    // 3.8.0 (string) accepts either 'section_title', 'field_title', or 'normal'
+        'placement'                 => 'normal', // 3.8.0 (string) accepts either 'section_title', 'field_title', or 'normal'
         
         // @todo    Examine why an array is not set but null here for the attributes argument.
-        'attributes'                => null,    // 3.0.0 - the array represents the attributes of input tag
+        'attributes'                => null, // 3.0.0 - the array represents the attributes of input tag
         'class'                     => array(   // 3.3.1
             'fieldrow'  =>  array(),
             'fieldset'  =>  array(),
@@ -68,29 +68,29 @@ 
             'field'     =>  array(),
         ), 
 
-        'save'                      => true,    // 3.6.0
-        'content'                   => null,    // 3.6.1 - (string) An overriding field-set output.
+        'save'                      => true, // 3.6.0
+        'content'                   => null, // 3.6.1 - (string) An overriding field-set output.
         
-        'show_debug_info'           => null,    // 3.8.8+  (boolean) whether to show debug information such as field definition tool-tips. This value is inherited from the section definition argument of the same name. Not setting a value here as it is determined with another calculated value.
+        'show_debug_info'           => null, // 3.8.8+  (boolean) whether to show debug information such as field definition tool-tips. This value is inherited from the section definition argument of the same name. Not setting a value here as it is determined with another calculated value.
         
         // Internal Keys
-        '_fields_type'              => null,    // @deprecated  3.7.0, 3.0.0 - an internal key that indicates the fields type such as page, meta box for pages, meta box for posts, or taxonomy.
-        '_structure_type'           => null,    // 3.7.0
-        '_caller_object'            => null,    // 3.4.0 (object) stores the object of the caller class. The object is referenced when creating nested fields.
+        '_fields_type'              => null, // @deprecated  3.7.0, 3.0.0 - an internal key that indicates the fields type such as page, meta box for pages, meta box for posts, or taxonomy.
+        '_structure_type'           => null, // 3.7.0
+        '_caller_object'            => null, // 3.4.0 (object) stores the object of the caller class. The object is referenced when creating nested fields.
                                                          
-        '_section_path'             => '',      // 3.7.0 (string) Stores the section path that indicates the structural address of the nested section. e.g. my_section|nested_one
-        '_section_path_array'       => '',      // 3.7.0 (array) An array version of the above section path.
-        '_nested_depth'             => 0,       // 3.4.0 (integer) stores the level of the nesting depth. This is mostly used for debugging by checking if the field is a nested field or not.        
-        '_subsection_index'         => null,    // 3.7.0 Passed to the `field_definition_{...}` filter hook callbacks.
-        '_section_repeatable'       => false,   // @deprecated
-        '_is_section_repeatable'    => false,   // 3.8.0 (boolean) Whether the belonging section is repeatable or not.
+        '_section_path'             => '', // 3.7.0 (string) Stores the section path that indicates the structural address of the nested section. e.g. my_section|nested_one
+        '_section_path_array'       => '', // 3.7.0 (array) An array version of the above section path.
+        '_nested_depth'             => 0, // 3.4.0 (integer) stores the level of the nesting depth. This is mostly used for debugging by checking if the field is a nested field or not.        
+        '_subsection_index'         => null, // 3.7.0 Passed to the `field_definition_{...}` filter hook callbacks.
+        '_section_repeatable'       => false, // @deprecated
+        '_is_section_repeatable'    => false, // 3.8.0 (boolean) Whether the belonging section is repeatable or not.
                
-        '_field_path'               => '',      // 3.7.0 (string) Stores the field path that indicates the structural location of the field. This is relative to the belonging section.
+        '_field_path'               => '', // 3.7.0 (string) Stores the field path that indicates the structural location of the field. This is relative to the belonging section.
         '_field_path_array'         => array(), // 3.7.0 (array) An array version of the above field path.
-        '_parent_field_path'        => '',      // 3.8.0 (string)
+        '_parent_field_path'        => '', // 3.8.0 (string)
         '_parent_field_path_array'  => array(), // 3.8.0 (array)
         
-        '_is_title_embedded'        => false,   // 3.8.0 (boolean) whether the field title is in the fieldset element, not in the table th element. This becomes `true` for `section_title` fields and fields with the `placement` argument with the value of `section_title` or `field_title`.
+        '_is_title_embedded'        => false, // 3.8.0 (boolean) whether the field title is in the fieldset element, not in the table th element. This becomes `true` for `section_title` fields and fields with the `placement` argument with the value of `section_title` or `field_title`.
         
     );        
     
@@ -167,14 +167,14 @@ 
             array( 
                 '_fields_type'           => $this->sStructureType, // @deprecated 3.7.0 backward-compatibility
                 '_structure_type'        => $this->sStructureType,  
-                '_caller_object'         => $this->oCallerObject,  // 3.4.1+ Stores the caller form object. 
-                '_subsection_index'      => $this->iSubSectionIndex,  // 3.7.0+
+                '_caller_object'         => $this->oCallerObject, // 3.4.1+ Stores the caller form object. 
+                '_subsection_index'      => $this->iSubSectionIndex, // 3.7.0+
             )
             + $this->aFieldset,
             array( 
                 'capability'             => $this->sCapability,
                 'section_id'             => '_default',             
-                '_section_repeatable'    => $this->bIsSectionRepeatable,   // @deprecated  3.8.0   This was not used.
+                '_section_repeatable'    => $this->bIsSectionRepeatable, // @deprecated  3.8.0   This was not used.
                 '_is_section_repeatable' => $this->bIsSectionRepeatable,
             )
             + self::$aStructure
@@ -295,12 +295,12 @@ 
           
             );
 
-            foreach( $aNestedFieldsets as $_isIndex => &$_aNestedFieldset ) {
+            foreach ( $aNestedFieldsets as $_isIndex => &$_aNestedFieldset ) {
                 
                 // The inline-mixed type has a string element.
                 if ( is_scalar( $_aNestedFieldset ) ) {                    
                     $_aNestedFieldset = array( 
-                        'field_id'              => $aParentFieldset[ 'field_id' ] . '_' . uniqid(),
+                        'field_id'              => $aParentFieldset[ 'field_id' ].'_'.uniqid(),
                         'content'               => $_aNestedFieldset,
                     );                    
                 }

Braces +3 added lines, -3 removed lines

@@ -195,7 +195,7 @@ 
         $_aFieldset[ 'class' ] = $this->getAsArray( $_aFieldset[ 'class' ] );
 
         // 3.8.0+ Support nested fields and inline_mized field type.
-        if ( $this->hasFieldDefinitionsInContent( $_aFieldset ) ) {        
+        if ( $this->hasFieldDefinitionsInContent( $_aFieldset ) ) {
             $_aFieldset[ 'content' ] = $this->_getChildFieldsetsFormatted( $_aFieldset[ 'content' ], $_aFieldset );
         }        
         
@@ -222,7 +222,7 @@ 
          * @since       3.8.8
          * @return      boolean
          */
-        private function _getShowDebugInfo( $aFieldset ) {   
+        private function _getShowDebugInfo( $aFieldset ) {
 
             // If the user sets a value. use it.
             if ( isset( $aFieldset[ 'show_debug_info' ] ) ) {
@@ -298,7 +298,7 @@ 
             foreach( $aNestedFieldsets as $_isIndex => &$_aNestedFieldset ) {
                 
                 // The inline-mixed type has a string element.
-                if ( is_scalar( $_aNestedFieldset ) ) {                    
+                if ( is_scalar( $_aNestedFieldset ) ) {
                     $_aNestedFieldset = array( 
                         'field_id'              => $aParentFieldset[ 'field_id' ] . '_' . uniqid(),
                         'content'               => $_aNestedFieldset,

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

Spacing +27 added lines, -27 removed lines

@@ -35,47 +35,47 @@ 
         // Optional
         'page_slug'         => null,
         'tab_slug'          => null,
-        'section_tab_slug'  => null,    // 3.0.0+
+        'section_tab_slug'  => null, // 3.0.0+
         'title'             => null,
         'description'       => null,
         'capability'        => null,
         'if'                => true,    
-        'order'             => null,    // do not set the default number here because incremented numbers will be added when registering the sections.
+        'order'             => null, // do not set the default number here because incremented numbers will be added when registering the sections.
         'help'              => null,
         'help_aside'        => null,
-        'repeatable'        => false,   // (boolean|array) 3.0.0+
-        'sortable'          => false,   // (boolean|array) 3.6.0+
+        'repeatable'        => false, // (boolean|array) 3.0.0+
+        'sortable'          => false, // (boolean|array) 3.6.0+
         'attributes'        => array(   // 3.3.1+
-            'class'         => null,    // set null to avoid undefined index warnings.
-            'style'         => null,    // set null to avoid undefined index warnings.
+            'class'         => null, // set null to avoid undefined index warnings.
+            'style'         => null, // set null to avoid undefined index warnings.
             'tab'           => array(),
         ),
         'class'             => array(    // 3.3.1+
             'tab'           => array(),
         ),
-        'hidden'            => false,    // 3.3.1+
-        'collapsible'       => false,    // 3.4.0+ (boolean|array) For the array structure see the $aStructure_CollapsibleArguments property.
-        'save'              => true,     // 3.6.0+
+        'hidden'            => false, // 3.3.1+
+        'collapsible'       => false, // 3.4.0+ (boolean|array) For the array structure see the $aStructure_CollapsibleArguments property.
+        'save'              => true, // 3.6.0+
         
-        'content'           => null,     // 3.6.1+  (string) An overriding section-set output.
+        'content'           => null, // 3.6.1+  (string) An overriding section-set output.
         
-        'tip'               => null,     // 3.7.0  (string) Tool tip HTML strings. 
+        'tip'               => null, // 3.7.0  (string) Tool tip HTML strings. 
         
         // Internal
-        '_fields_type'      => null,     // @deprecated 3.7.0+ Use the `_structure_type` instead. 3.0.0+ - same as the one of the field definition array. Used to insert debug info at the bottom of sections.        
-        '_structure_type'   => null,     // 3.7.0+
-        '_is_first_index'   => false,    // 3.4.0+ (boolean) indicates whether it is the first item of the sub-sections (for repeatable sections).
-        '_is_last_index'    => false,    // 3.4.0+ (boolean) indicates whether it is the last item of the sub-sections (for repeatable sections).
+        '_fields_type'      => null, // @deprecated 3.7.0+ Use the `_structure_type` instead. 3.0.0+ - same as the one of the field definition array. Used to insert debug info at the bottom of sections.        
+        '_structure_type'   => null, // 3.7.0+
+        '_is_first_index'   => false, // 3.4.0+ (boolean) indicates whether it is the first item of the sub-sections (for repeatable sections).
+        '_is_last_index'    => false, // 3.4.0+ (boolean) indicates whether it is the last item of the sub-sections (for repeatable sections).
         
-        '_section_path'         => '',       // 3.7.0+ (string) e.g. my_section|nested_section       
-        '_section_path_array'   => '',       // 3.7.0+ (array) an array version of the above section_path argument. Numerically indexed.
-        '_nested_depth'         => 0,        // 3.7.0+ (integer) the nested level of the section
+        '_section_path'         => '', // 3.7.0+ (string) e.g. my_section|nested_section       
+        '_section_path_array'   => '', // 3.7.0+ (array) an array version of the above section_path argument. Numerically indexed.
+        '_nested_depth'         => 0, // 3.7.0+ (integer) the nested level of the section
         
         // 3.6.0+ - (object) the caller framework factory object. This allows the framework to access the factory property when rendering the section.
         // 3.7.0+  It no longer stores a factory object but a form object.
         '_caller_object'    => null,     
         
-        'show_debug_info'   => null,    // 3.8.8+ (boolean) Whether to display debug information. Inherits the page/in-page-tab setting (actually the factory property value of `$bShowDebugInfo` which gets updated by the page/tab setting).
+        'show_debug_info'   => null, // 3.8.8+ (boolean) Whether to display debug information. Inherits the page/in-page-tab setting (actually the factory property value of `$bShowDebugInfo` which gets updated by the page/tab setting).
         
     );        
     
@@ -94,7 +94,7 @@ 
     
     public $oCaller             = null;
     
-    public $bShowDebugInfo      = true;     // 3.8.8+
+    public $bShowDebugInfo      = true; // 3.8.8+
     
     /**
      * Sets up properties.
@@ -108,7 +108,7 @@ 
             $this->sCapability, 
             $this->iCountOfElements,
             $this->oCaller,
-            $this->bShowDebugInfo,      // 3.8.8+
+            $this->bShowDebugInfo, // 3.8.8+
         );
         $this->aSectionset          = $_aParameters[ 0 ];
         $this->sSectionPath         = $_aParameters[ 1 ];
@@ -116,7 +116,7 @@ 
         $this->sCapability          = $_aParameters[ 3 ];
         $this->iCountOfElements     = $_aParameters[ 4 ];
         $this->oCaller              = $_aParameters[ 5 ];
-        $this->bShowDebugInfo       = $_aParameters[ 6 ];   // 3.8.8+
+        $this->bShowDebugInfo       = $_aParameters[ 6 ]; // 3.8.8+
 
     }
     
@@ -131,16 +131,16 @@ 
         $_aSectionPath = explode( '|', $this->sSectionPath );
         $_aSectionset  = $this->uniteArrays(
             array( 
-                '_fields_type'          => $this->sStructureType,   // @deprecated  3.7.0+
-                '_structure_type'       => $this->sStructureType,   // 3.7.0+
-                '_section_path'         => $this->sSectionPath,     // 3.7.0+
+                '_fields_type'          => $this->sStructureType, // @deprecated  3.7.0+
+                '_structure_type'       => $this->sStructureType, // 3.7.0+
+                '_section_path'         => $this->sSectionPath, // 3.7.0+
                 '_section_path_array'   => $_aSectionPath,
-                '_nested_depth'         => count( $_aSectionPath ) - 1,    // 3.7.0+ - zero base
+                '_nested_depth'         => count( $_aSectionPath ) - 1, // 3.7.0+ - zero base
             ) 
             + $this->aSectionset
             + array(
                 'capability'        => $this->sCapability,
-                'show_debug_info'   => $this->bShowDebugInfo,   // 3.8.8+
+                'show_debug_info'   => $this->bShowDebugInfo, // 3.8.8+
             ),
             self::$aStructure
         );

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

Spacing +2 added lines, -2 removed lines

@@ -218,8 +218,8 @@
      * @remark $_aDefaultKeys holds shared default key-values defined in the base class.
      */
     protected $aDefaultKeys = array(
-        'label_min_width'  => '',       // disabled as the embedded elements are all inline.
-        'show_debug_info'  => false,    // 3.8.8+ @todo Examine why this value does not override the default value of field definition arguments and if possible and appropriate, override it.
+        'label_min_width'  => '', // disabled as the embedded elements are all inline.
+        'show_debug_info'  => false, // 3.8.8+ @todo Examine why this value does not override the default value of field definition arguments and if possible and appropriate, override it.
     );
 
     

Braces +1 added lines, -1 removed lines

@@ -229,7 +229,7 @@
      * @internal
      * @return      string
      */        
-    protected function getStyles() { 
+    protected function getStyles() {
         return <<<CSSRULES
 .admin-page-framework-field-inline_mixed {
     width: 98%;

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

Spacing +7 added lines, -7 removed lines

@@ -28,9 +28,9 @@ 
      * @return      void
      * @since       3.8.8
      */
-    static public function showDeprecationNotice( $sDeprecated, $sAlternative='', $sProgramName='Admin Page Framework' ) {
+    static public function showDeprecationNotice( $sDeprecated, $sAlternative = '', $sProgramName = 'Admin Page Framework' ) {
         trigger_error(
-            $sProgramName . ': ' . sprintf(
+            $sProgramName.': '.sprintf(
                 $sAlternative
                     ? '<code>%1$s</code> has been deprecated. Use <code>%2$s</code> instead.'
                     : '<code>%1$s</code> has been deprecated.',
@@ -52,8 +52,8 @@ 
      * @param       callable            $oCallable
      * @param       string|array        $asParameters       Parameters to pass to the callback function.
      */
-    public function callBack( $oCallable, $asParameters=array() ) {
-        $_aParameters   = self::getAsArray( 
+    public function callBack( $oCallable, $asParameters = array() ) {
+        $_aParameters = self::getAsArray( 
             $asParameters, 
             true // preserve empty
         );
@@ -89,7 +89,7 @@ 
      * @since       3.6.3
      * @return      string      The captured output buffer.
      */
-    static public function getOutputBuffer( $oCallable, array $aParameters=array() ) {
+    static public function getOutputBuffer( $oCallable, array $aParameters = array() ) {
         
         ob_start(); 
         echo call_user_func_array( $oCallable, $aParameters );
@@ -110,7 +110,7 @@ 
         
         $_iCount     = count( get_object_vars( $oInstance ) );
         $_sClassName = get_class( $oInstance );
-        return '(object) ' . $_sClassName . ': ' . $_iCount . ' properties.';
+        return '(object) '.$_sClassName.': '.$_iCount.' properties.';
         
     }
                    
@@ -127,7 +127,7 @@ 
      * @param       boolean|integer|double|string|array|object|resource|NULL        $mTrue      The value to return when the first parameter value yields false.
      * @return      mixed
      */
-    static public function getAOrB( $mValue, $mTrue=null, $mFalse=null ) {
+    static public function getAOrB( $mValue, $mTrue = null, $mFalse = null ) {
         return $mValue ? $mTrue : $mFalse;
     }    
     

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

Spacing +10 added lines, -10 removed lines

@@ -31,7 +31,7 @@ 
      * @deprecated  3.8.0       Use `getLengthSanitized()` instead.
      * @since       3.8.8       Moved from `AdminPageFramework_Utility_String`.
      */
-    static public function sanitizeLength( $sLength, $sUnit='px' ) {
+    static public function sanitizeLength( $sLength, $sUnit = 'px' ) {
         AdminPageFramework_Utility::showDeprecationNotice( __FUNCTION__, 'getLengthSanitized()' );
         return AdminPageFramework_Utility_String::getLengthSanitized( $sLength, $sUnit );
     }    
@@ -50,12 +50,12 @@ 
      * @since       3.5.3           Moved from `AdminPageFramework_Utility_Array`.
      * @deprecated  3.5.3           Use `getElement()`. 
      */
-    public static function getCorrespondingArrayValue( $vSubject, $sKey, $sDefault='', $bBlankToDefault=false ) {    
+    public static function getCorrespondingArrayValue( $vSubject, $sKey, $sDefault = '', $bBlankToDefault = false ) {    
                 
         AdminPageFramework_Utility::showDeprecationNotice( __FUNCTION__, 'getElement()' );
                 
         // If $vSubject is null,
-        if ( ! isset( $vSubject ) ) { 
+        if ( !isset( $vSubject ) ) { 
             return $sDefault; 
         }
             
@@ -65,7 +65,7 @@ 
         }
             
         // If $vSubject is not an array, 
-        if ( ! is_array( $vSubject ) ) { 
+        if ( !is_array( $vSubject ) ) { 
             return ( string ) $vSubject; 
         } // consider it as string.
         
@@ -116,11 +116,11 @@ 
      * @since       3.5.3       Moved from `AdminPageFramework_FieldType_Base`.
      * @deprecated  3.5.3       Use the `getElement()` method.
      */
-    protected function getFieldElementByKey( $asElement, $sKey, $asDefault='' ) {
+    protected function getFieldElementByKey( $asElement, $sKey, $asDefault = '' ) {
         
         AdminPageFramework_Utility::showDeprecationNotice( __FUNCTION__, 'getElement()' );
         
-        if ( ! is_array( $asElement ) || ! isset( $sKey ) ) {
+        if ( !is_array( $asElement ) || !isset( $sKey ) ) {
             return $asElement; 
         }
                 
@@ -143,7 +143,7 @@ 
         
         AdminPageFramework_Utility::showDeprecationNotice( __FUNCTION__ );
         
-        foreach( $aArray as &$vElem ) {
+        foreach ( $aArray as &$vElem ) {
             
             if ( $vElem ) { break; }
             unset( $vElem );
@@ -177,15 +177,15 @@ 
         
         AdminPageFramework_Utility::showDeprecationNotice( __METHOD__, 'AdminPageFramework_WPUtility::getAttributes()' );
         
-        $_sQuoteCharactor   ="'";
+        $_sQuoteCharactor   = "'";
         $_aOutput           = array();
-        foreach( $aAttributes as $sAttribute => $sProperty ) {
+        foreach ( $aAttributes as $sAttribute => $sProperty ) {
        
             // Must be resolved as a string.
             if ( in_array( gettype( $sProperty ), array( 'array', 'object' ) ) ) {
                 continue;
             }
-            $_aOutput[] = "{$sAttribute}={$_sQuoteCharactor}{$sProperty}{$_sQuoteCharactor}";
+            $_aOutput[ ] = "{$sAttribute}={$_sQuoteCharactor}{$sProperty}{$_sQuoteCharactor}";
             
         }
         return implode( ' ', $_aOutput );

Braces +5 added lines, -5 removed lines

@@ -50,27 +50,27 @@
      * @since       3.5.3           Moved from `AdminPageFramework_Utility_Array`.
      * @deprecated  3.5.3           Use `getElement()`. 
      */
-    public static function getCorrespondingArrayValue( $vSubject, $sKey, $sDefault='', $bBlankToDefault=false ) {    
+    public static function getCorrespondingArrayValue( $vSubject, $sKey, $sDefault='', $bBlankToDefault=false ) {
                 
         AdminPageFramework_Utility::showDeprecationNotice( __FUNCTION__, 'getElement()' );
                 
         // If $vSubject is null,
-        if ( ! isset( $vSubject ) ) { 
+        if ( ! isset( $vSubject ) ) {
             return $sDefault; 
         }
             
         // If the $bBlankToDefault flag is set and the subject value is a blank string, return the default value.
-        if ( $bBlankToDefault && $vSubject == '' ) { 
+        if ( $bBlankToDefault && $vSubject == '' ) {
             return  $sDefault; 
         }
             
         // If $vSubject is not an array, 
-        if ( ! is_array( $vSubject ) ) { 
+        if ( ! is_array( $vSubject ) ) {
             return ( string ) $vSubject; 
         } // consider it as string.
         
         // Consider $vSubject as array.
-        if ( isset( $vSubject[ $sKey ] ) ) { 
+        if ( isset( $vSubject[ $sKey ] ) ) {
             return $vSubject[ $sKey ]; 
         }
         

development/factory/_common/utility/AdminPageFramework_FrameworkUtility.php

Spacing +5 added lines, -5 removed lines

@@ -23,7 +23,7 @@ 
      * @since       3.8.8
      * @return      void
      */
-    static public function showDeprecationNotice( $sDeprecated, $sAlternative='', $sProgramName='' ) {
+    static public function showDeprecationNotice( $sDeprecated, $sAlternative = '', $sProgramName = '' ) {
         $sProgramName = $sProgramName ? $sProgramName : self::getFrameworkName();
         parent::showDeprecationNotice( $sDeprecated, $sAlternative, $sProgramName );
     }
@@ -42,8 +42,8 @@ 
             return;
         }
 
-        foreach( ( array ) $GLOBALS[ '_apf_sub_menus_to_sort' ] as $_sIndex => $_sMenuSlug ) {
-            if ( ! isset( $GLOBALS[ 'submenu' ][ $_sMenuSlug ] ) ) {
+        foreach ( ( array ) $GLOBALS[ '_apf_sub_menus_to_sort' ] as $_sIndex => $_sMenuSlug ) {
+            if ( !isset( $GLOBALS[ 'submenu' ][ $_sMenuSlug ] ) ) {
                 continue;
             }       
             ksort( $GLOBALS[ 'submenu' ][ $_sMenuSlug ] );
@@ -68,7 +68,7 @@ 
      * @param       boolean     $bTrimDevVer           Whether the `.dev` suffix should be removed or not.
      * @return      string
      */
-    static public function getFrameworkVersion( $bTrimDevVer=false ) {
+    static public function getFrameworkVersion( $bTrimDevVer = false ) {
         $_sVersion = AdminPageFramework_Registry::getVersion();
         return $bTrimDevVer
             ? self::getSuffixRemoved( $_sVersion, '.dev' )
@@ -96,7 +96,7 @@ 
      * @return      string
      */
     static public function getFrameworkNameVersion() {
-        return self::getFrameworkName() . ' ' . self::getFrameworkVersion();
+        return self::getFrameworkName().' '.self::getFrameworkVersion();
     }
         
 }