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 

Braces +2 added lines, -2 removed lines

@@ -15,7 +15,7 @@ 
  * @extends     AdminPageFramework_Form_View___Section_Base
  * @internal
  */
-class AdminPageFramework_Form_View___ToolTip extends AdminPageFramework_Form_View___Section_Base {            
+class AdminPageFramework_Form_View___ToolTip extends AdminPageFramework_Form_View___Section_Base {
   
     /**
      * Stores the default argument values.
@@ -154,7 +154,7 @@ 
          * @since       3.7.0
          * @return      string
          */
-        private function _getDescriptions() {         
+        private function _getDescriptions() {
             if ( isset( $this->aArguments[ 'content' ] ) ) {
                 return "<span " . $this->_getElementAttributes( 'description', 'admin-page-framework-form-tooltip-description' ) . ">"
                         . implode( 

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/AdminPageFramework_Form_View___DebugInfo.php

Spacing +4 added lines, -4 removed lines

@@ -19,7 +19,7 @@ 
  */
 class AdminPageFramework_Form_View___DebugInfo extends AdminPageFramework_FrameworkUtility {            
 
-    public $sStructureType   = '';
+    public $sStructureType = '';
     
     /**
      * @since       3.8.5
@@ -57,12 +57,12 @@ 
      */
     public function get() {
         
-        if ( ! $this->_shouldProceed() ) {
+        if ( !$this->_shouldProceed() ) {
             return '';
         }
         
         return "<div class='admin-page-framework-info'>" 
-                . $this->oMsg->get( 'debug_info' ) . ': '
+                . $this->oMsg->get( 'debug_info' ).': '
                     . $this->getFrameworkNameVersion()
             . "</div>";
         
@@ -73,7 +73,7 @@ 
          */
         private function _shouldProceed() {
 
-            if ( ! $this->callBack( $this->aCallbacks[ 'show_debug_info' ], true ) ) {
+            if ( !$this->callBack( $this->aCallbacks[ 'show_debug_info' ], true ) ) {
                 return false;
             }        
             // For the generic admin pages, do no show debug information for each section.

Braces +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
  * @extends     AdminPageFramework_FrameworkUtility
  * @internal
  */
-class AdminPageFramework_Form_View___DebugInfo extends AdminPageFramework_FrameworkUtility {            
+class AdminPageFramework_Form_View___DebugInfo extends AdminPageFramework_FrameworkUtility {
 
     public $sStructureType   = '';
     

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

Spacing +16 added lines, -16 removed lines

@@ -77,9 +77,9 @@ 
      * Defines the default key-values of this field type. 
      */
     protected $aDefaultKeys = array(
-        'select_all_button'     => false,        // 3.3.0+   to change the label, set the label here
-        'select_none_button'    => false,        // 3.3.0+   to change the label, set the label here
-        'save_unchecked'        => true,        // (optional, boolean) 3.8.8+   Whether to store the values of unchecked items.
+        'select_all_button'     => false, // 3.3.0+   to change the label, set the label here
+        'select_none_button'    => false, // 3.3.0+   to change the label, set the label here
+        'save_unchecked'        => true, // (optional, boolean) 3.8.8+   Whether to store the values of unchecked items.
     );
         
     /**
@@ -91,7 +91,7 @@ 
      */ 
     protected function getScripts() {
         new AdminPageFramework_Form_View___Script_CheckboxSelector;
-        $_sClassSelectorSelectAll  = $this->_getSelectButtonClassSelectors( 
+        $_sClassSelectorSelectAll = $this->_getSelectButtonClassSelectors( 
             $this->aFieldTypeSlugs, 
             'select_all_button' // data attribute
         );
@@ -118,14 +118,14 @@ 
          * @return      string
          * @internal
          */
-        private function _getSelectButtonClassSelectors( array $aFieldTypeSlugs, $sDataAttribute='select_all_button' ) {
+        private function _getSelectButtonClassSelectors( array $aFieldTypeSlugs, $sDataAttribute = 'select_all_button' ) {
             
             $_aClassSelectors = array();
             foreach ( $aFieldTypeSlugs as $_sSlug ) {
-                if ( ! is_scalar( $_sSlug ) ) {
+                if ( !is_scalar( $_sSlug ) ) {
                     continue;
                 }
-                $_aClassSelectors[] = '.admin-page-framework-checkbox-container-' . $_sSlug . "[data-{$sDataAttribute}]";
+                $_aClassSelectors[ ] = '.admin-page-framework-checkbox-container-'.$_sSlug."[data-{$sDataAttribute}]";
             }
             return implode( ',', $_aClassSelectors );
             
@@ -186,8 +186,8 @@ 
 
         $_aOutput       = array();
         $_bIsMultiple   = is_array( $aField[ 'label' ] );
-        foreach( $this->getAsArray( $aField[ 'label' ], true ) as $_sKey => $_sLabel ) {
-            $_aOutput[] = $this->_getEachCheckboxOutput( 
+        foreach ( $this->getAsArray( $aField[ 'label' ], true ) as $_sKey => $_sLabel ) {
+            $_aOutput[ ] = $this->_getEachCheckboxOutput( 
                 $aField, 
                 $_bIsMultiple 
                     ? $_sKey 
@@ -195,7 +195,7 @@ 
                 $_sLabel
             );
         }        
-        return "<div " . $this->getAttributes( $this->_getCheckboxContainerAttributes( $aField ) ) . ">"
+        return "<div ".$this->getAttributes( $this->_getCheckboxContainerAttributes( $aField ) ).">"
                 . "<div class='repeatable-field-buttons'></div>" // the repeatable field buttons will be replaced with this element.
                 . implode( PHP_EOL, $_aOutput )
             . "</div>";
@@ -210,12 +210,12 @@ 
          */
         protected function _getCheckboxContainerAttributes( array $aField ) {
             return array(
-                'class'                     => 'admin-page-framework-checkbox-container-' . $aField[ 'type' ],
+                'class'                     => 'admin-page-framework-checkbox-container-'.$aField[ 'type' ],
                 'data-select_all_button'    => $aField[ 'select_all_button' ] 
-                    ? ( ! is_string( $aField[ 'select_all_button' ] ) ? $this->oMsg->get( 'select_all' ) : $aField[ 'select_all_button' ] )
+                    ? ( !is_string( $aField[ 'select_all_button' ] ) ? $this->oMsg->get( 'select_all' ) : $aField[ 'select_all_button' ] )
                     : null,
                 'data-select_none_button'   => $aField[ 'select_none_button' ] 
-                    ? ( ! is_string( $aField[ 'select_none_button' ] ) ? $this->oMsg->get( 'select_none' ) : $aField[ 'select_none_button' ] )
+                    ? ( !is_string( $aField[ 'select_none_button' ] ) ? $this->oMsg->get( 'select_none' ) : $aField[ 'select_none_button' ] )
                     : null,
             );            
         }
@@ -230,7 +230,7 @@ 
         private function _getEachCheckboxOutput( array $aField, $sKey, $sLabel ) {
 
             $_aInputAttributes = array(
-                'data-key'  => $sKey,   // 3.8.8+ For the `post_type_taxonomy` field type.
+                'data-key'  => $sKey, // 3.8.8+ For the `post_type_taxonomy` field type.
             ) + $aField[ 'attributes' ];
             $_oCheckbox = new AdminPageFramework_Input_checkbox( 
                 $_aInputAttributes,
@@ -241,8 +241,8 @@ 
             $_oCheckbox->setAttributesByKey( $sKey );
             $_oCheckbox->addClass( $this->_sCheckboxClassSelector );
             return $this->getElementByLabel( $aField[ 'before_label' ], $sKey, $aField[ 'label' ] )
-                . "<div " . $this->getLabelContainerAttributes( $aField, 'admin-page-framework-input-label-container admin-page-framework-checkbox-label' ) . ">" 
-                    . "<label " . $this->getAttributes( 
+                . "<div ".$this->getLabelContainerAttributes( $aField, 'admin-page-framework-input-label-container admin-page-framework-checkbox-label' ).">" 
+                    . "<label ".$this->getAttributes( 
                         array(
                             'for'   => $_oCheckbox->getAttribute( 'id' ),
                             'class' => $_oCheckbox->getAttribute( 'disabled' )

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

Spacing +9 added lines, -9 removed lines

@@ -63,16 +63,16 @@ 
      *  - use_desc_for_title    (boolean|int) default is 1 - Whether to use the category description as the title attribute. side note: the framework enables this by default.
      * @param       integer     $iCurrentObjectID
      */
-    function start_el( &$sOutput, $oTerm, $iDepth=0, $aArgs=array(), $iCurrentObjectID=0 ) {
+    function start_el( &$sOutput, $oTerm, $iDepth = 0, $aArgs = array(), $iCurrentObjectID = 0 ) {
        
         $aArgs = $aArgs + array(
             '_name_prefix'      => null,
             '_input_id_prefix'  => null,
             '_attributes'       => array(),
             '_selected_items'   => array(),
-            'taxonomy'          => null,    // parsed by the core function to perform the database query.
-            'disabled'          => null,    // not sure what this was for
-            '_save_unchecked'   => true,    // 3.8.8+
+            'taxonomy'          => null, // parsed by the core function to perform the database query.
+            'disabled'          => null, // not sure what this was for
+            '_save_unchecked'   => true, // 3.8.8+
         );
         
         // Local variables
@@ -84,7 +84,7 @@ 
 
         // Post count
         $_sPostCount     = $aArgs[ 'show_post_count' ] 
-            ? " <span class='font-lighter'>(" . $oTerm->count . ")</span>" 
+            ? " <span class='font-lighter'>(".$oTerm->count.")</span>" 
             : '';
         
         // Attributes
@@ -103,7 +103,7 @@ 
           + array(
             'class'     => null,
         );
-        $_aInputAttributes['class'] .= ' apf_checkbox';
+        $_aInputAttributes[ 'class' ] .= ' apf_checkbox';
         
         $_aLiTagAttributes = array(
             'id'        => "list-{$_sID}",
@@ -112,15 +112,15 @@ 
         );
 
         $_sHiddenInputForUnchecked = $aArgs[ '_save_unchecked' ]
-            ? "<input value='0' type='hidden' name='" . $_aInputAttributes[ 'name' ] . "' class='apf_checkbox' />"
+            ? "<input value='0' type='hidden' name='".$_aInputAttributes[ 'name' ]."' class='apf_checkbox' />"
             : '';
             
         // Output - the variable is by reference so the modification takes effect
         $sOutput .= "\n"
-            . "<li " . AdminPageFramework_WPUtility::getAttributes( $_aLiTagAttributes ) . ">" 
+            . "<li ".AdminPageFramework_WPUtility::getAttributes( $_aLiTagAttributes ).">" 
                 . "<label for='{$_sID}' class='taxonomy-checklist-label'>"
                     . $_sHiddenInputForUnchecked    // 3.8.8+
-                    . "<input " . AdminPageFramework_WPUtility::getAttributes( $_aInputAttributes ) . " />"
+                    . "<input ".AdminPageFramework_WPUtility::getAttributes( $_aInputAttributes )." />"
                     . esc_html( apply_filters( 'the_category', $oTerm->name ) ) 
                     . $_sPostCount
                 . "</label>";    

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

Spacing +13 added lines, -13 removed lines

@@ -81,7 +81,7 @@ 
     /**
      * Defines the field type slugs used for this field type.
      */
-    public $aFieldTypeSlugs = array( 'posttype', );
+    public $aFieldTypeSlugs = array( 'posttype',);
     
     /**
      * Defines the default key-values of this field type. 
@@ -89,20 +89,20 @@ 
      * @remark $_aDefaultKeys holds shared default key-values defined in the base class.
      */
     protected $aDefaultKeys = array(
-        'slugs_to_remove'       => null,    // the default array will be assigned in the rendering method.
+        'slugs_to_remove'       => null, // the default array will be assigned in the rendering method.
         /** 
          * Accepts query arguments. For the argument specification, see the arg parameter of get_post_types() function.
          * See: http://codex.wordpress.org/Function_Reference/get_post_types#Parameters
          */
-        'query'                 => array(),  // 3.2.1+
-        'operator'              => 'and',    // 3.2.1+ either 'and' or 'or'
+        'query'                 => array(), // 3.2.1+
+        'operator'              => 'and', // 3.2.1+ either 'and' or 'or'
         'attributes'            => array(
             'size'      => 30,
             'maxlength' => 400,
         ),    
-        'select_all_button'     => true,     // 3.3.0+   to change the label, set the label here
-        'select_none_button'    => true,     // 3.3.0+   to change the label, set the label here        
-        'save_unchecked'        => true,     // (optional, boolean) 3.8.8+   Whether to store the values of unchecked items.
+        'select_all_button'     => true, // 3.3.0+   to change the label, set the label here
+        'select_none_button'    => true, // 3.3.0+   to change the label, set the label here        
+        'save_unchecked'        => true, // (optional, boolean) 3.8.8+   Whether to store the values of unchecked items.
     );
     protected $aDefaultRemovingPostTypeSlugs = array(
         'revision', 
@@ -119,7 +119,7 @@ 
      */ 
     protected function getStyles() {
         $_sParentStyles = parent::getStyles();
-        return $_sParentStyles . <<<CSSRULES
+        return $_sParentStyles.<<<CSSRULES
 /* Posttype Field Type */
 .admin-page-framework-field input[type='checkbox'] {
     margin-right: 0.5em;
@@ -146,11 +146,11 @@ 
      */
     protected function getField( $aField ) {
 
-        $this->_sCheckboxClassSelector = '';    // disable the checkbox class selector.
+        $this->_sCheckboxClassSelector = ''; // disable the checkbox class selector.
         $aField[ 'label' ] = $this->_getPostTypeArrayForChecklist( 
             isset( $aField[ 'slugs_to_remove' ] ) 
                 ? $this->getAsArray( $aField[ 'slugs_to_remove' ] ) 
-                : $this->aDefaultRemovingPostTypeSlugs,    // slugs to remove
+                : $this->aDefaultRemovingPostTypeSlugs, // slugs to remove
             $aField[ 'query' ],
             $aField[ 'operator' ]
         );
@@ -171,11 +171,11 @@ 
          * @return  array   The array holding the elements of installed post types' labels and their slugs except the specified expluding post types.
          * @internal
          */ 
-        private function _getPostTypeArrayForChecklist( $aSlugsToRemove, $asQueryArgs=array(), $sOperator='and' ) {
+        private function _getPostTypeArrayForChecklist( $aSlugsToRemove, $asQueryArgs = array(), $sOperator = 'and' ) {
             
             $_aPostTypes = array();
-            foreach( get_post_types( $asQueryArgs, 'objects' ) as $_oPostType ) {
-                if (  isset( $_oPostType->name, $_oPostType->label ) ) {
+            foreach ( get_post_types( $asQueryArgs, 'objects' ) as $_oPostType ) {
+                if ( isset( $_oPostType->name, $_oPostType->label ) ) {
                     $_aPostTypes[ $_oPostType->name ] = $_oPostType->label;
                 }
             }

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

Braces +1 added lines, -1 removed lines

@@ -441,7 +441,7 @@
          * @since       3.8.8
          * @return      array       Post type slugs associated with the given taxonomy.
          */
-        private function _getPostTypesByTaxonomySlug( $sTaxonomySlug ) {            
+        private function _getPostTypesByTaxonomySlug( $sTaxonomySlug ) {
             $_oTaxonomy = get_taxonomy( $sTaxonomySlug );
             return $_oTaxonomy->object_type;            
         }

Spacing +39 added lines, -39 removed lines

@@ -118,7 +118,7 @@ 
      * Defines the field type slugs used for this field type.
      * @var     array
      */
-    public $aFieldTypeSlugs = array( 'taxonomy', );
+    public $aFieldTypeSlugs = array( 'taxonomy',);
     
     /**
      * Defines the default key-values of this field type. 
@@ -127,41 +127,41 @@ 
      * @var     array
      */
     protected $aDefaultKeys = array(
-        'taxonomy_slugs'        => 'category',      // (array|string) This is for the taxonomy field type.
-        'height'                => '250px',         // the tab box height
-        'width'                 => null,            // 3.5.7.2+ the tab box width
-        'max_width'             => '100%',          // for the taxonomy checklist field type, since 2.1.1.     
-        'show_post_count'       => true,            // (boolean) 3.2.0+ whether or not the post count associated with the term should be displayed or not.
+        'taxonomy_slugs'        => 'category', // (array|string) This is for the taxonomy field type.
+        'height'                => '250px', // the tab box height
+        'width'                 => null, // 3.5.7.2+ the tab box width
+        'max_width'             => '100%', // for the taxonomy checklist field type, since 2.1.1.     
+        'show_post_count'       => true, // (boolean) 3.2.0+ whether or not the post count associated with the term should be displayed or not.
         'attributes'            => array(),    
-        'select_all_button'     => true,            // (boolean|string) 3.3.0+ to change the label, set the label here
-        'select_none_button'    => true,            // (boolean|string) 3.3.0+ to change the label, set the label here                
-        'label_no_term_found'   => null,            // (string) 3.3.2+  The label to display when no term is found. null needs to be set here as the default value will be assigned in the field output method.
-        'label_list_title'      => '',              // (string) 3.3.2+ The heading title string for a term list. Default: `''`. Insert an HTML custom string right before the list starts.
+        'select_all_button'     => true, // (boolean|string) 3.3.0+ to change the label, set the label here
+        'select_none_button'    => true, // (boolean|string) 3.3.0+ to change the label, set the label here                
+        'label_no_term_found'   => null, // (string) 3.3.2+  The label to display when no term is found. null needs to be set here as the default value will be assigned in the field output method.
+        'label_list_title'      => '', // (string) 3.3.2+ The heading title string for a term list. Default: `''`. Insert an HTML custom string right before the list starts.
         'query'                 => array(       // (array)  3.3.2+ Defines the default query argument.
             // see the arguments of the get_category() function: http://codex.wordpress.org/Function_Reference/get_categories
             // see the argument of the get_terms() function: http://codex.wordpress.org/Function_Reference/get_terms        
             'child_of'          => 0,
             'parent'            => '',
-            'orderby'           => 'name',      // (string) 'ID' or 'term_id' or 'name'
-            'order'             => 'ASC',       // (string) 'ASC' or 'DESC'
-            'hide_empty'        => false,       // (boolean) whether to show the terms with no post associated. Default: false
-            'hierarchical'      => true,        // (boolean) whether to show the terms as a hierarchical tree.
-            'number'            => '',          // (integer) The maximum number of the terms to show.
-            'pad_counts'        => false,       // (boolean) whether to sum up the post counts with the child post counts.
-            'exclude'           => array(),     // (string) Comma separated term IDs to exclude from the list. for example `1` will remove the 'Uncategorized' category from the list.
+            'orderby'           => 'name', // (string) 'ID' or 'term_id' or 'name'
+            'order'             => 'ASC', // (string) 'ASC' or 'DESC'
+            'hide_empty'        => false, // (boolean) whether to show the terms with no post associated. Default: false
+            'hierarchical'      => true, // (boolean) whether to show the terms as a hierarchical tree.
+            'number'            => '', // (integer) The maximum number of the terms to show.
+            'pad_counts'        => false, // (boolean) whether to sum up the post counts with the child post counts.
+            'exclude'           => array(), // (string) Comma separated term IDs to exclude from the list. for example `1` will remove the 'Uncategorized' category from the list.
             'exclude_tree'      => array(), 
-            'include'           => array(),     // (string) Comma separated term IDs to include in the list.
+            'include'           => array(), // (string) Comma separated term IDs to include in the list.
             'fields'            => 'all', 
             'slug'              => '', 
             'get'               => '', 
             'name__like'        => '',
             'description__like' => '',
             'offset'            => '', 
-            'search'            => '',          // (string) The search keyword to get the term with.
+            'search'            => '', // (string) The search keyword to get the term with.
             'cache_domain'      => 'core',
         ),
-        'queries'   => array(),         // (optional, array) 3.3.2+  Sets a query argument for each taxonomy. The array key must be the taxonomy slug and the value is the query argument array.
-        'save_unchecked'        => true,        // (optional, boolean) 3.8.8+   Whether to store the values of unchecked items.
+        'queries'   => array(), // (optional, array) 3.3.2+  Sets a query argument for each taxonomy. The array key must be the taxonomy slug and the value is the query argument array.
+        'save_unchecked'        => true, // (optional, boolean) 3.8.8+   Whether to store the values of unchecked items.
     );
     
     /**
@@ -191,7 +191,7 @@ 
 
         $_aJSArray = json_encode( $this->aFieldTypeSlugs );
         
-        return parent::getScripts() . 
+        return parent::getScripts(). 
         // return 
 <<<JAVASCRIPTS
 /* For tabs */
@@ -412,22 +412,22 @@ 
         // Parse
         $_aTabs         = array();
         $_aCheckboxes   = array();      
-        foreach( $this->getAsArray( $aField[ 'taxonomy_slugs' ] ) as $_isKey => $_sTaxonomySlug ) {
+        foreach ( $this->getAsArray( $aField[ 'taxonomy_slugs' ] ) as $_isKey => $_sTaxonomySlug ) {
             $_aAssociatedDataAttributes = $this->_getDataAttributesOfAssociatedPostTypes( 
                 $_sTaxonomySlug, 
                 $this->_getPostTypesByTaxonomySlug( $_sTaxonomySlug )
             );
-            $_aTabs[]                   = $this->_getTaxonomyTab( $aField, $_isKey, $_sTaxonomySlug, $_aAssociatedDataAttributes );
-            $_aCheckboxes[]             = $this->_getTaxonomyCheckboxes( $aField, $_isKey, $_sTaxonomySlug, $_aAssociatedDataAttributes );
+            $_aTabs[ ]                   = $this->_getTaxonomyTab( $aField, $_isKey, $_sTaxonomySlug, $_aAssociatedDataAttributes );
+            $_aCheckboxes[ ]             = $this->_getTaxonomyCheckboxes( $aField, $_isKey, $_sTaxonomySlug, $_aAssociatedDataAttributes );
         }
 
         // Output
-        return "<div id='tabbox-{$aField['field_id']}' class='tab-box-container categorydiv' style='max-width:{$aField['max_width']};'>"
+        return "<div id='tabbox-{$aField[ 'field_id' ]}' class='tab-box-container categorydiv' style='max-width:{$aField[ 'max_width' ]};'>"
                 . "<ul class='tab-box-tabs category-tabs'>" 
                     . implode( PHP_EOL, $_aTabs ) 
                 . "</ul>" 
                 . "<div class='tab-box-contents-container'>"
-                    . "<div class='tab-box-contents' style='height: {$aField['height']};'>"
+                    . "<div class='tab-box-contents' style='height: {$aField[ 'height' ]};'>"
                         . implode( PHP_EOL, $_aCheckboxes )
                     . "</div>"
                 . "</div>" 
@@ -453,7 +453,7 @@ 
         private function _getDataAttributesOfAssociatedPostTypes( $sTaxonomySlusg, $aPostTypes ) {
             return array(
                 'data-associated-with'       => $sTaxonomySlusg,
-                'data-associated-post-types' => implode( ',', $aPostTypes ) . ',',  // must add a trailing comma for jQuery to detect the item.
+                'data-associated-post-types' => implode( ',', $aPostTypes ).',', // must add a trailing comma for jQuery to detect the item.
             );
         }
     
@@ -468,7 +468,7 @@ 
         private function _getTaxonomyCheckboxes( array $aField, $sKey, $sTaxonomySlug, $aAttributes ) {
             
             $_aTabBoxContainerArguments = array(
-                'id'    => "tab_{$aField['input_id']}_{$sKey}",
+                'id'    => "tab_{$aField[ 'input_id' ]}_{$sKey}",
                 'class' => 'tab-box-content',
                 'style' => $this->getInlineCSS(
                     array(
@@ -477,9 +477,9 @@ 
                     )
                 ),
             ) + $aAttributes;
-            return "<div " . $this->getAttributes( $_aTabBoxContainerArguments ) . ">"
+            return "<div ".$this->getAttributes( $_aTabBoxContainerArguments ).">"
                     . $this->getElement( $aField, array( 'before_label', $sKey ) )
-                    . "<div " . $this->getAttributes( $this->_getCheckboxContainerAttributes( $aField ) ) . ">"
+                    . "<div ".$this->getAttributes( $this->_getCheckboxContainerAttributes( $aField ) ).">"
                     . "</div>"
                     . "<ul class='list:category taxonomychecklist form-no-clear'>"
                         . $this->_getTaxonomyChecklist( $aField, $sKey, $sTaxonomySlug )
@@ -504,7 +504,7 @@ 
                         'taxonomy'              => $sTaxonomySlug, 
                         '_name_prefix'          => is_array( $aField[ 'taxonomy_slugs' ] ) 
                             ? "{$aField[ '_input_name' ]}[{$sTaxonomySlug}]" 
-                            : $aField[ '_input_name' ],   // name prefix of the input
+                            : $aField[ '_input_name' ], // name prefix of the input
                         '_input_id_prefix'      => $aField[ 'input_id' ],
                         '_attributes'           => $this->getElementAsArray( 
                             $aField, 
@@ -512,12 +512,12 @@ 
                         ) + $aField[ 'attributes' ],                 
                         
                         // checked items ( term IDs ) e.g.  array( 6, 10, 7, 15 ), 
-                        '_selected_items'       => $this->_getSelectedKeyArray( $aField['value'], $sTaxonomySlug ),
+                        '_selected_items'       => $this->_getSelectedKeyArray( $aField[ 'value' ], $sTaxonomySlug ),
                         
-                        'echo'                  => false,  // returns the output
-                        'show_post_count'       => $aField[ 'show_post_count' ],      // 3.2.0+
-                        'show_option_none'      => $aField[ 'label_no_term_found' ],  // 3.3.2+ 
-                        'title_li'              => $aField[ 'label_list_title' ],     // 3.3.2+
+                        'echo'                  => false, // returns the output
+                        'show_post_count'       => $aField[ 'show_post_count' ], // 3.2.0+
+                        'show_option_none'      => $aField[ 'label_no_term_found' ], // 3.3.2+ 
+                        'title_li'              => $aField[ 'label_list_title' ], // 3.3.2+
                         
                         '_save_unchecked'       => $aField[ 'save_unchecked' ], // 3.8.8+ Whether to insert hidden input element for unchecked.
                     ) 
@@ -564,8 +564,8 @@ 
             $_aLiAttribues = array(
                 'class' => 'tab-box-tab',
             ) + $aAttributes;
-            return "<li " . $this->getAttributes( $_aLiAttribues ) . ">"
-                    . "<a href='#tab_{$aField['input_id']}_{$sKey}'>"
+            return "<li ".$this->getAttributes( $_aLiAttribues ).">"
+                    . "<a href='#tab_{$aField[ 'input_id' ]}_{$sKey}'>"
                         . "<span class='tab-box-tab-text'>" 
                             . $this->_getLabelFromTaxonomySlug( $sTaxonomySlug )
                         . "</span>"

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;
         }