michaeluno / admin-page-framework

development/factory/_common/form/_view/AdminPageFramework_Form_View___ToolTip.php

Doc Comments +1 added lines, -2 removed lines

@@ -42,8 +42,6 @@ 
      * Sets up properties.
      * @since       3.6.0
      * @since       3.7.0           Changed the parameter structure.
-     * @param       array|string    $asArguments        The content output or the tooltip argument array.
-     * @param       string          $sTitleElementID    Not used at the moment.
      */
     public function __construct( /* $aArguments, $sTitleElementID */ ) {
 
@@ -170,6 +168,7 @@ 
 
     /**
      * Generates HTML attributes of the specified element.
+     * @param string $sElementKey
      * @return      string
      * @since       3.8.5
      */

Spacing +14 added lines, -14 removed lines

@@ -21,7 +21,7 @@ 
     /**
      * Stores the default argument values.
      */
-    public $aArguments      = array(
+    public $aArguments = array(
         'attributes'    => array(
             'container'   => array(),   
             'title'       => array(),
@@ -29,11 +29,11 @@ 
             'description' => array(),
             'icon'        => array(),
         ), 
-        'icon'          => null,    // the icon output to override
-        'dash-icon'     => 'dashicons-editor-help',   // the dash-icon class selector for the icon
-        'icon_alt_text' => '[?]',   // [3.8.5+] alternative text when icon is not available. For WP v3.7.x or below.
+        'icon'          => null, // the icon output to override
+        'dash-icon'     => 'dashicons-editor-help', // the dash-icon class selector for the icon
+        'icon_alt_text' => '[?]', // [3.8.5+] alternative text when icon is not available. For WP v3.7.x or below.
         'title'         => null,  
-        'content'       => null,    // will be assigned in the constructor
+        'content'       => null, // will be assigned in the constructor
     );
     
     public $sTitleElementID;
@@ -90,7 +90,7 @@ 
                 if ( is_string( $asContent ) ) {
                     return true;
                 }
-                if ( is_array( $asContent ) && ! $this->isAssociative( $asContent ) ) {
+                if ( is_array( $asContent ) && !$this->isAssociative( $asContent ) ) {
                     return true;
                 }
                 return false;
@@ -104,12 +104,12 @@ 
      * @return      string      The output.
      */
     public function get() {
-        if ( ! $this->aArguments[ 'content' ] ) {
+        if ( !$this->aArguments[ 'content' ] ) {
             return '';
         }
-        return "<a " . $this->_getElementAttributes( 'container', 'admin-page-framework-form-tooltip' ) . ">"
+        return "<a ".$this->_getElementAttributes( 'container', 'admin-page-framework-form-tooltip' ).">"
                 . $this->_getTipLinkIcon()
-                . "<span " . $this->_getElementAttributes( 'content', 'admin-page-framework-form-tooltip-content' ) . ">"
+                . "<span ".$this->_getElementAttributes( 'content', 'admin-page-framework-form-tooltip-content' ).">"
                     . $this->_getTipTitle()
                     . $this->_getDescriptions()
                 . "</span>"
@@ -127,7 +127,7 @@ 
                 return $this->aArguments[ 'icon' ];
             }
             if ( version_compare( $GLOBALS[ 'wp_version' ], '3.8', '>=' ) ) {
-                return "<span " . $this->_getElementAttributes( 
+                return "<span ".$this->_getElementAttributes( 
                         'icon', 
                         array(
                             'dashicons', 
@@ -145,7 +145,7 @@ 
          */
         private function _getTipTitle() {
             if ( isset( $this->aArguments[ 'title' ] ) ) {
-                return "<span " . $this->_getElementAttributes( 'title', 'admin-page-framework-form-tooltip-title' ) . ">"
+                return "<span ".$this->_getElementAttributes( 'title', 'admin-page-framework-form-tooltip-title' ).">"
                     . $this->aArguments[ 'title' ]
                     . "</span>";
             }
@@ -157,9 +157,9 @@ 
          */
         private function _getDescriptions() {         
             if ( isset( $this->aArguments[ 'content' ] ) ) {
-                return "<span " . $this->_getElementAttributes( 'description', 'admin-page-framework-form-tooltip-description' ) . ">"
+                return "<span ".$this->_getElementAttributes( 'description', 'admin-page-framework-form-tooltip-description' ).">"
                         . implode( 
-                            "</span><span " . $this->_getElementAttributes( 'description', 'admin-page-framework-form-tooltip-description' ) . ">", 
+                            "</span><span ".$this->_getElementAttributes( 'description', 'admin-page-framework-form-tooltip-description' ).">", 
                             $this->getAsArray( $this->aArguments[ 'content' ] )
                         )
                     . "</span>"
@@ -178,7 +178,7 @@ 
         $_aContainerAttributes = $this->getElementAsArray(
             $this->aArguments,
             array( 'attributes', $sElementKey )
-        ) + array( 'class' => '' ) ;
+        ) + array( 'class' => '' );
         $_aContainerAttributes[ 'class' ] = $this->getClassAttribute( 
             $_aContainerAttributes[ 'class' ], 
             $asClassSelectors 

admin-page-framework-loader.php

Spacing +22 added lines, -22 removed lines

@@ -16,9 +16,9 @@ 
  */
 class AdminPageFrameworkLoader_Registry_Base {
 
-    const VERSION        = '3.8.5b01';    // <--- DON'T FORGET TO CHANGE THIS AS WELL!!
+    const VERSION        = '3.8.5b01'; // <--- 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/factory/_common/form/_view/sectionset/AdminPageFramework_Form_View___FieldsetTableRow.php

Spacing +8 added lines, -8 removed lines

@@ -33,7 +33,7 @@ 
 
         $_aParameters = func_get_args() + array( 
             $this->aFieldset, 
-            $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->aCallbacks, // field output element callables.        
@@ -61,14 +61,14 @@ 
         
         $aFieldset = $this->aFieldset;
 
-        if ( ! $this->isNormalPlacement( $aFieldset ) ) {
+        if ( !$this->isNormalPlacement( $aFieldset ) ) {
             return '';
         }
 
-        $_oFieldrowAttribute   = new AdminPageFramework_Form_View___Attribute_Fieldrow( 
+        $_oFieldrowAttribute = new AdminPageFramework_Form_View___Attribute_Fieldrow( 
             $aFieldset,
             array( 
-                'id'        => 'fieldrow-' . $aFieldset[ 'tag_id' ],
+                'id'        => 'fieldrow-'.$aFieldset[ 'tag_id' ],
                 'valign'    => 'top',
                 'class'     => 'admin-page-framework-fieldrow',
             )                
@@ -77,7 +77,7 @@ 
         return $this->_getFieldByContainer( 
             $aFieldset, 
             array(
-                'open_container'    => "<tr " . $_oFieldrowAttribute->get() . ">",
+                'open_container'    => "<tr ".$_oFieldrowAttribute->get().">",
                 'close_container'   => "</tr>",
                 'open_title'        => "<th>",
                 'close_title'       => "</th>",
@@ -126,13 +126,13 @@ 
                 $this->aCallbacks,
                 $this->oMsg
             );
-            $_aOutput   = array();
+            $_aOutput = array();
             if ( $aFieldset[ 'show_title_column' ] ) {
-                $_aOutput[] = $aOpenCloseTags[ 'open_title' ]
+                $_aOutput[ ] = $aOpenCloseTags[ 'open_title' ]
                         . $_oFieldTitle->get()
                     . $aOpenCloseTags[ 'close_title' ];
             }
-            $_aOutput[] = $aOpenCloseTags[ 'open_main' ]
+            $_aOutput[ ] = $aOpenCloseTags[ 'open_main' ]
                     // . call_user_func_array( $hfCallback, array( $aFieldset ) )
                     . $this->getFieldsetOutput( $aFieldset )
                 . $aOpenCloseTags[ 'close_main' ];

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,18 +160,18 @@ 
          */
         private function _getDebugInfo( $aField ) {
             
-            if ( ! $this->isDebugMode() ) {
+            if ( !$this->isDebugMode() ) {
                 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->getFrameworkName() . ' ' . $this->getFrameworkVersion()
+                            . $this->getFrameworkName().' '.$this->getFrameworkVersion()
                         . '</span>',
                     'attributes'    => array(
                         'container' => array(
@@ -179,7 +179,7 @@ 
                         ),
                     )
                 ),
-                $aField[ 'field_id' ] . '_debug'
+                $aField[ 'field_id' ].'_debug'
             );            
             return $_oToolTip->get();                    
             
@@ -191,7 +191,7 @@ 
          */
         private function _getTitleColon( $aField ) {
             
-            if ( ! isset( $aField[ 'title' ] ) || '' === $aField[ 'title' ] ) {
+            if ( !isset( $aField[ 'title' ] ) || '' === $aField[ 'title' ] ) {
                 return '';
             }                    
             if ( 
@@ -199,8 +199,8 @@ 
                     $aField[ '_structure_type' ], 
                     array( 'widget', 'post_meta_box', 'page_meta_box' ) 
                 ) 
-            ){
-                return "<span class='title-colon'>:</span>" ;
+            ) {
+                return "<span class='title-colon'>:</span>";
             }                                                 
             
         }