michaeluno / admin-page-framework

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

Doc Comments +4 added lines, -1 removed lines

@@ -165,6 +165,7 @@ 
     }
         /**
          * @since       3.7.0
+         * @param string $_sOutput
          * @return      string
          */
         private function _getSpinnerOutput( $_sOutput ) {
@@ -299,7 +300,7 @@ 
              * @param       array       $_aOutputs      Holds output elements - contents, section tab list, count of subsections.
              * @param       string      $_sSectionsID   The container id of sections.
              * @param       array       $_aSection
-             * @param       array       $_aFieldsInSections     A field-sets array already divided by section tab.
+             * @param       array       $aFieldsInSections     A field-sets array already divided by section tab.
              * @return      array       The updated sections table output array.
              */
             private function _getSectionsetTable( $_aOutputs, $_sSectionsID, array $_aSection, array $aFieldsInSections ) {
@@ -354,6 +355,7 @@ 
                  * Returns the output of sub-sections for repeatable and sortable sections.
                  * 
                  * @since       3.7.0
+                 * @param string $_sSectionsID
                  * @return      array
                  */
                 private function _getSubSections( $_aOutputs, $_sSectionsID, $_aSection, $_aSubSections ) {
@@ -500,6 +502,7 @@ 
              * @since       3.5.3
              * @since       3.6.0       Removed the `$sSectionID` parameter. Added the `$aSectionset` parameter.
              * @since       3.7.0       Moved from `AdminPageFramework_FormPart_Table`.
+             * @param string $sSectionsID
              * @return      string      The formatted sections table HTML output.
              */
             private function _getFormattedSectionsTablesOutput( array $aOutputs, $aSectionset, $sSectionsID, array $aCollapsible, $sSectionTabSlug ) {

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/factory/admin_page/AdminPageFramework_Controller_Page.php

Doc Comments +4 added lines, -37 removed lines

@@ -52,43 +52,6 @@ 
      * @since       2.0.0
      * @since       3.0.0     Changed the scope to public. Added page slug target support. 
      * @since       3.3.1       Moved from `AdminPageFramework_Page`.
-     * @param       array     $aTab1 The in-page tab array.
-     * <h4>In-Page Tab Array</h4>
-     * <ul>
-     *     <li>**page_slug** - (string) the page slug that the tab belongs to.</li>
-     *     <li>**tab_slug** -  (string) the tab slug. Non-alphabetical characters should not be used including dots(.) and hyphens(-).</li>
-     *     <li>**title** - (string) the title of the tab.</li>
-     *     <li>**order** - (optional, integer) the order number of the tab. The lager the number is, the lower the position it is placed in the menu.</li>
-     *     <li>**show_in_page_tab** - (optional, boolean) default: `true`. If this is set to `false`, the tab title will not be displayed in the tab navigation menu; however, it is still accessible from the direct URL.</li>
-     *     <li>**parent_tab_slug** - (optional, string) this needs to be set if the above `show_in_page_tab` argument is `false` so that the parent tab will be emphasized as active when the hidden page is accessed.</li>
-     *     <li>**url** - [3.5.0+] (optional, string) If this is set, the link url of the navigation tab will be this url. Use this to create link only tab.</li>
-     *     <li>**capability** - [3.6.0+] (optional, string) The capability level.</li>
-     *     <li>**if** - [3.6.0+] (optional, boolean) Whether the tab should be displayed or not.</li>
-     *     <li>style - [3.6.3+] (optional) (string|array) The path or url of a stylesheet which gets loaded in the head tag. Or inline CSS rules.
-     * When custom arguments need to be set such as whether it should be inserted in the footer, set an array holding the following arguments.
-     *          <ul>
-     *              <li>src - (required, string) the source url or path.</li>    
-     *              <li>handle_id - (optional, string) The handle ID of the stylesheet.</li>    
-     *              <li>dependencies - (optional, array) The dependency array.</li>    
-     *              <li>version - (optional, string) The stylesheet version number.</li>    
-     *              <li>media - (optional, string) the description of the field which is inserted into the after the input field tag.</li>    
-     *          </ul>
-     *     </li>
-     *     <li>script - [3.6.3+] (optional) (string|array) The path or url of a JavaScript script which gets loaded in the head tag. Or an inline JavaScript script.
-     * When custom arguments need to be set such as whether it should be inserted in the footer, set an array holding the following arguments.
-     *          <ul>
-     *              <li>src - (required, string) the source url or path.</li>    
-     *              <li>handle_id - (optional, string) The handle ID of the stylesheet.</li>    
-     *              <li>dependencies - (optional, array) The dependency array.</li>    
-     *              <li>version - (optional, string) The stylesheet version number.</li>    
-     *              <li>translation - (optional, array) an array holding translation key-value pairs.</li>    
-     *          </ul>
-     *     </li>
-     *     <li>show_debug_info - [3.8.8+] (optional, boolean) Whether to show debug information. If `WP_DEBUG` is false, the debug output will not be displayed. Default: `true`.</li>
-     * </ul>
-     * @param       array       $aTab2      Another in-page tab array.
-     * @param       array       $_and_more  (optional) Add in-page tab arrays as many as necessary to the next parameters.
-     * @param       string      $sPageSlug  (optional) If the passed parameter item is a string, it will be stored as the target page slug so that it will be applied to the next passed tab arrays as the page_slug element.
      * @remark      Accepts variadic parameters; the number of accepted parameters are not limited to three.
      * @remark      In-page tabs are different from page-heading tabs which is automatically added with page titles.  
      * @return      void
@@ -278,6 +241,10 @@ 
         /**
          * Sets a page property.
          * @since       3.6.0
+         * @param string $sPropertyName
+         * @param string $sPropertyKey
+         * @param boolean|string $mValue
+         * @param string $sPageSlug
          * @return      void
          */
         private function _setPageProperty( $sPropertyName, $sPropertyKey, $mValue, $sPageSlug ) {

admin-page-framework-loader.php

Spacing +22 added lines, -22 removed lines

@@ -16,9 +16,9 @@ 
  */
 class AdminPageFrameworkLoader_Registry_Base {
 
-    const VERSION        = '3.8.8b02';    // <--- DON'T FORGET TO CHANGE THIS AS WELL!!
+    const VERSION        = '3.8.8b02'; // <--- DON'T FORGET TO CHANGE THIS AS WELL!!
     const NAME           = 'Admin Page Framework - Loader'; // the name is not 'Admin Page Framework' because warning messages gets confusing.
-    const SHORTNAME      = 'Admin Page Framework';  // used for a menu title etc.
+    const SHORTNAME      = 'Admin Page Framework'; // used for a menu title etc.
     const DESCRIPTION    = 'Loads Admin Page Framework which facilitates WordPress plugin and theme development.';
     const URI            = 'http://admin-page-framework.michaeluno.jp/';
     const AUTHOR         = 'miunosoft (Michael Uno)';
@@ -55,14 +55,14 @@ 
      * @remark      This is also accessed from `uninstall.php` so do not remove.
      * @remark      Do not exceed 8 characters as a transient name allows 45 characters or less ( 40 for site transients ) so that md5 (32 characters) can be added.
      */
-    const TRANSIENT_PREFIX         = 'APFL_';
+    const TRANSIENT_PREFIX = 'APFL_';
 
     /**
      * The hook slug used for the prefix of action and filter hook names.
      * 
      * @remark      The ending underscore is not necessary.
      */
-    const HOOK_SLUG                = 'admin_page_framework_loader';
+    const HOOK_SLUG = 'admin_page_framework_loader';
 
     /**
      * The text domain slug and its path.
@@ -116,7 +116,7 @@ 
      */
     static public $aAdminPages = array(
         // key => 'page slug'
-        'about'     => 'apfl_about',        // the welcome page
+        'about'     => 'apfl_about', // the welcome page
         'addon'     => 'apfl_addons',
         'tool'      => 'apfl_tools',
         'help'      => 'apfl_contact',
@@ -154,12 +154,12 @@ 
      * @since       3.5.0
      * @return      string
      */
-    public static function getPluginURL( $sRelativePath='' ) {
+    public static function getPluginURL( $sRelativePath = '' ) {
         if ( isset( self::$_sPluginURLCache ) ) {
-            return self::$_sPluginURLCache . $sRelativePath;
+            return self::$_sPluginURLCache.$sRelativePath;
         }
         self::$_sPluginURLCache = trailingslashit( plugins_url( '', self::$sFilePath ) );
-        return self::$_sPluginURLCache . $sRelativePath;
+        return self::$_sPluginURLCache.$sRelativePath;
     }
         /**
          * @since       3.7.9
@@ -189,13 +189,13 @@ 
      * @since       3.5.0
      * @return      void
      */ 
-    static public function setAdminNotice( $sMessage, $sClassAttribute='error' ) {
-        if ( ! is_admin() ) {  
+    static public function setAdminNotice( $sMessage, $sClassAttribute = 'error' ) {
+        if ( !is_admin() ) {  
             return; 
         }
-        self::$_aAdminNotices[] = array(
+        self::$_aAdminNotices[ ] = array(
             'message'           => $sMessage,
-            'class_attribute'   => trim( $sClassAttribute ) . ' notice is-dismissible',
+            'class_attribute'   => trim( $sClassAttribute ).' notice is-dismissible',
         );
         add_action( 'admin_notices', array( __CLASS__, '_replyToSetAdminNotice' ) );
     }
@@ -205,12 +205,12 @@ 
          * @return      void
          */
         static public function _replyToSetAdminNotice() {
-            foreach( self::$_aAdminNotices as $_aAdminNotice ) {
-                echo "<div class='" . esc_attr( $_aAdminNotice['class_attribute'] ) . " notice is-dismissible'>"
+            foreach ( self::$_aAdminNotices as $_aAdminNotice ) {
+                echo "<div class='".esc_attr( $_aAdminNotice[ 'class_attribute' ] )." notice is-dismissible'>"
                         ."<p>"
                             . sprintf(
-                                '<strong>%1$s</strong>: ' . $_aAdminNotice['message'],
-                                self::NAME . ' ' . self::VERSION
+                                '<strong>%1$s</strong>: '.$_aAdminNotice[ 'message' ],
+                                self::NAME.' '.self::VERSION
                             )
                         . "</p>"
                     . "</div>";
@@ -222,7 +222,7 @@ 
 AdminPageFrameworkLoader_Registry::setUp( __FILE__ );
 
 // Initial checks. - Do no load if accessed directly, not exiting because the 'uninstall.php' and inclusion list generator will load this file.
-if ( ! defined( 'ABSPATH' ) ) {
+if ( !defined( 'ABSPATH' ) ) {
     return;
 }
 if ( defined( 'DOING_UNINSTALL' ) ) {
@@ -234,8 +234,8 @@ 
 
     $_bFrameworkLoaded = class_exists( 'AdminPageFramework_Registry', false );
     if (
-        ! $_bFrameworkLoaded
-        || ! defined( 'AdminPageFramework_Registry::VERSION' ) // backward compatibility
+        !$_bFrameworkLoaded
+        || !defined( 'AdminPageFramework_Registry::VERSION' ) // backward compatibility
         || version_compare( AdminPageFramework_Registry::VERSION, AdminPageFrameworkLoader_Registry::VERSION, '<' )
     ) {
         AdminPageFrameworkLoader_Registry::setAdminNotice(
@@ -253,18 +253,18 @@ 
 add_action( 'admin_init', 'AdminPageFrameworkLoader_Warning' );
 
 // Include the library file - the development version will be available if you cloned the GitHub repository.
-$_sDevelopmentVersionPath = AdminPageFrameworkLoader_Registry::$sDirPath . '/development/admin-page-framework.php';
+$_sDevelopmentVersionPath = AdminPageFrameworkLoader_Registry::$sDirPath.'/development/admin-page-framework.php';
 $_bDebugMode              = defined( 'WP_DEBUG' ) && WP_DEBUG;
 $_bLoadDevelopmentVersion = $_bDebugMode && file_exists( $_sDevelopmentVersionPath );
 include(
     $_bLoadDevelopmentVersion
         ? $_sDevelopmentVersionPath
-        : AdminPageFrameworkLoader_Registry::$sDirPath . '/library/apf/admin-page-framework.php'
+        : AdminPageFrameworkLoader_Registry::$sDirPath.'/library/apf/admin-page-framework.php'
 );
 
 // Include the framework loader plugin components.
 include( AdminPageFramework_Registry::$aClassFiles[ 'AdminPageFramework_PluginBootstrap' ] );
-include( AdminPageFrameworkLoader_Registry::$sDirPath . '/include/class/AdminPageFrameworkLoader_Bootstrap.php' );
+include( AdminPageFrameworkLoader_Registry::$sDirPath.'/include/class/AdminPageFrameworkLoader_Bootstrap.php' );
 new AdminPageFrameworkLoader_Bootstrap(
     AdminPageFrameworkLoader_Registry::$sFilePath,
     AdminPageFrameworkLoader_Registry::HOOK_SLUG    // hook prefix

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

@@ -18,14 +18,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();
@@ -91,7 +91,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 );
@@ -101,7 +101,7 @@ 
             $_bHasOtherFields       = $_sFieldsInSectionTitle
                 ? ' has-fields'
                 : '';
-            $_sOutput               = $_sTitle . $_sFieldsInSectionTitle;
+            $_sOutput               = $_sTitle.$_sFieldsInSectionTitle;
             return $_sOutput
                 ? "<div class='section-title-container{$_bHasOtherFields}'>"
                     . $_sOutput 
@@ -130,7 +130,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
@@ -145,14 +145,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::get( $aSectionset )
                                 . '<span class="admin-page-framework-info">'
                                     . $this->getFrameworkNameVersion()
@@ -166,7 +166,7 @@ 
                                 ),
                             )
                         ),
-                        $aSectionset[ '_section_path' ] . '_debug'
+                        $aSectionset[ '_section_path' ].'_debug'
                     );            
                     return $_oToolTip->get();                    
                     
@@ -195,8 +195,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 );
@@ -212,7 +212,7 @@ 
                 private function _getFieldsetsInSectionTitleArea( array $aFieldsets, $iSectionIndex, $aFieldTypeDefinitions ) {
                     
                     $_aFieldsetsInSectionTitle = array();
-                    foreach( $aFieldsets as $_aFieldset ) {
+                    foreach ( $aFieldsets as $_aFieldset ) {
                         
                         if ( 'section_title' !== $_aFieldset[ 'placement' ] ) {
                             continue;
@@ -223,7 +223,7 @@ 
                             $iSectionIndex,
                             $aFieldTypeDefinitions
                         );         
-                        $_aFieldsetsInSectionTitle[] = $_oFieldsetOutputFormatter->get();
+                        $_aFieldsetsInSectionTitle[ ] = $_oFieldsetOutputFormatter->get();
                         
                     }
                     return $_aFieldsetsInSectionTitle;
@@ -242,7 +242,7 @@ 
                  */
                 private function _getSectionTitleField( array $aFieldsets, $iSectionIndex, $aFieldTypeDefinitions ) {   
                 
-                    foreach( $aFieldsets as $_aFieldset ) {
+                    foreach ( $aFieldsets as $_aFieldset ) {
                         
                         if ( 'section_title' !== $_aFieldset[ 'type' ] ) {
                             continue;

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

Spacing +15 added lines, -15 removed lines

@@ -70,7 +70,7 @@ 
         
         $aField = $this->aFieldset;
         
-        if ( ! $aField[ 'show_title_column' ] ) {
+        if ( !$aField[ 'show_title_column' ] ) {
             return '';
         }          
             
@@ -84,7 +84,7 @@ 
             'for'   => $_oInputTagIDGenerator->get(),
         );
         $_sOutput .= $aField[ 'title' ]
-            ? "<label " . $this->getAttributes( $_aLabelAttributes ) . "'>"
+            ? "<label ".$this->getAttributes( $_aLabelAttributes )."'>"
                     . "<a id='{$aField[ 'field_id' ]}'></a>"  // to allow the browser to link to the element.
                     . "<span title='" 
                             . esc_attr( 
@@ -115,12 +115,12 @@ 
          */
         private function _getFieldOutputsInFieldTitleAreaFromNestedFields( $aField ) {
             
-            if ( ! $this->hasNestedFields( $aField ) ) {
+            if ( !$this->hasNestedFields( $aField ) ) {
                 return '';
             }
             
             $_sOutput = '';
-            foreach( $aField[ 'content' ] as $_aNestedField ) {
+            foreach ( $aField[ 'content' ] as $_aNestedField ) {
                 
                 if ( 'field_title' !== $_aNestedField[ 'placement' ] ) {
                     continue;
@@ -128,13 +128,13 @@ 
 
                 $_oFieldset = new AdminPageFramework_Form_View___Fieldset( 
                     $_aNestedField, 
-                    $this->aSavedData,    // passed by reference. @todo: examine why it needs to be passed by reference.
+                    $this->aSavedData, // passed by reference. @todo: examine why it needs to be passed by reference.
                     $this->aFieldErrors, 
                     $this->aFieldTypeDefinitions,
                     $this->oMsg,
                     $this->aCallbacks // field output element callables.
                 );
-                $_sOutput   .= $_oFieldset->get(); // field output                
+                $_sOutput .= $_oFieldset->get(); // field output                
 
             }
             return $_sOutput;
@@ -146,7 +146,7 @@ 
          * @since       3.7.0
          */
         private function _getToolTip( $asTip, $sElementID ) {
-            $_oToolTip           = new AdminPageFramework_Form_View___ToolTip(
+            $_oToolTip = new AdminPageFramework_Form_View___ToolTip(
                 $asTip,
                 $sElementID
             );            
@@ -160,14 +160,14 @@ 
          */
         private function _getDebugInfo( $aField ) {
             
-            if ( ! $this->_shouldShowDebugInfo( $aField ) ) {
+            if ( !$this->_shouldShowDebugInfo( $aField ) ) {
                 return '';
             }
-            $_oToolTip           = new AdminPageFramework_Form_View___ToolTip(
+            $_oToolTip = new AdminPageFramework_Form_View___ToolTip(
                 array(
                     'title'         => $this->oMsg->get( 'field_arguments' ),
                     'dash-icon'     => 'dashicons-info',
-                    'icon_alt_text' => '[' . $this->oMsg->get( 'debug' ) . ' ]',
+                    'icon_alt_text' => '['.$this->oMsg->get( 'debug' ).' ]',
                     'content'       => AdminPageFramework_Debug::get( $aField )
                         . '<span class="admin-page-framework-info">'
                             . $this->getFrameworkNameVersion()
@@ -181,7 +181,7 @@ 
                         ),
                     )
                 ),
-                $aField[ 'field_id' ] . '_debug'
+                $aField[ 'field_id' ].'_debug'
             );            
             return $_oToolTip->get();                    
             
@@ -192,7 +192,7 @@ 
              */
             private function _shouldShowDebugInfo( $aField ) {
                 
-                if ( ! $aField[ 'show_debug_info' ] ) {
+                if ( !$aField[ 'show_debug_info' ] ) {
                     return false;
                 }
                 if ( strlen( $aField[ '_parent_field_path' ] ) ) {
@@ -208,7 +208,7 @@ 
          */
         private function _getTitleColon( $aField ) {
             
-            if ( ! isset( $aField[ 'title' ] ) || '' === $aField[ 'title' ] ) {
+            if ( !isset( $aField[ 'title' ] ) || '' === $aField[ 'title' ] ) {
                 return '';
             }                    
             if ( 
@@ -216,8 +216,8 @@ 
                     $aField[ '_structure_type' ], 
                     array( 'widget', 'post_meta_box', 'page_meta_box' ) 
                 ) 
-            ){
-                return "<span class='title-colon'>:</span>" ;
+            ) {
+                return "<span class='title-colon'>:</span>";
             }                                                 
             
         }

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

Spacing +11 added lines, -11 removed lines

@@ -64,9 +64,9 @@ 
         }
 
         $_aSectionsets = $this->_getSectionsetsFormatted(
-            array(),                // section-sets array to modify - new formatted items will be stored here
-            $this->aSectionsets,    // parsing section-sets
-            array(),                // section path - empty for root 
+            array(), // section-sets array to modify - new formatted items will be stored here
+            $this->aSectionsets, // parsing section-sets
+            array(), // section path - empty for root 
             $this->sCapability      // capability
         );
 
@@ -83,10 +83,10 @@ 
          */
         private function _getSectionsetsFormatted( $_aNewSectionsets, $aSectionsetsToParse, $aSectionPath, $sCapability ) {
 
-            foreach( $aSectionsetsToParse as $_sSectionPath => $_aSectionset ) {
+            foreach ( $aSectionsetsToParse as $_sSectionPath => $_aSectionset ) {
 
                 // The '_default' section can be empty so do not check `if ( empty( $_aSectionset ) )` here.
-                if ( ! is_array( $_aSectionset ) ) { 
+                if ( !is_array( $_aSectionset ) ) { 
                     continue; 
                 }
                 
@@ -117,7 +117,7 @@ 
                 
                 // 3.7.0+ For nested sections         
                 $_aNewSectionsets = $this->_getNestedSections( 
-                    $_aNewSectionsets,  // sectionset array to modify
+                    $_aNewSectionsets, // sectionset array to modify
                     $_aSectionset, 
                     $_aSectionPath, // section path
                     $_aSectionset[ 'capability' ]
@@ -134,15 +134,15 @@ 
              */
             private function _getNestedSections( $aSectionsetsToEdit, $aSectionset, $aSectionPath, $sCapability ) {
 
-                if ( ! $this->_hasNestedSections( $aSectionset ) ) {
+                if ( !$this->_hasNestedSections( $aSectionset ) ) {
                     return $aSectionsetsToEdit;
                 }
 
                 // Recursive call
                 return $this->_getSectionsetsFormatted(
-                        $aSectionsetsToEdit,          // section-sets array to modify - new formatted items will be stored here
-                        $aSectionset[ 'content' ],    // parsing section-sets
-                        $aSectionPath,                // section path - empty for root 
+                        $aSectionsetsToEdit, // section-sets array to modify - new formatted items will be stored here
+                        $aSectionset[ 'content' ], // parsing section-sets
+                        $aSectionPath, // section path - empty for root 
                         $sCapability                  // capability
                     );                          
 
@@ -155,7 +155,7 @@ 
                 private function _hasNestedSections( $aSectionset ) {
                     
                     $aSectionset = $aSectionset + array( 'content' => null );
-                    if ( ! is_array( $aSectionset[ 'content' ] ) ) {
+                    if ( !is_array( $aSectionset[ 'content' ] ) ) {
                         return false;
                     }
                     $_aContents  = $aSectionset[ 'content' ];

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,