michaeluno / admin-page-framework

development/factory/_common/form/_model/AdminPageFramework_Form_Model___LastInput.php

Doc Comments -1 removed lines

@@ -110,7 +110,6 @@
      * Retrieves the settings error array set by the user in the validation callback.
      * 
      * @since       3.7.8
-     * @param       boolean     $bDelete    whether or not the transient should be deleted after retrieving it. 
      * @return      array
      */
     public function get() {

Spacing +5 added lines, -5 removed lines

@@ -57,7 +57,7 @@ 
             $_sTabSlug  = $this->getElement( $_GET, 'tab', '' );
             $_sUserID   = get_current_user_id();
 
-            return "apf_li_" . md5(
+            return "apf_li_".md5(
                 $_sPageNow
                 . $_sPageSlug
                 . $_sTabSlug
@@ -95,13 +95,13 @@ 
          * @return      void
          */
         public function _replyToSave() {
-            if ( ! isset( self::$_aLastInputs ) ) {
+            if ( !isset( self::$_aLastInputs ) ) {
                 return;
             }
             $this->setTransient(
                 $this->sTransientKey,
                 self::$_aLastInputs,
-                60*60     // store it for 1 hour 
+                60 * 60     // store it for 1 hour 
             );
         }
     
@@ -121,9 +121,9 @@ 
             $_aLastInputs = self::$_aCaches[ $this->sTransientKey ];
         } else {
             $_aLastInputs = $this->getTransient( $this->sTransientKey );
-            self::$_aCaches[ $this->sTransientKey ]  = $_aLastInputs;
+            self::$_aCaches[ $this->sTransientKey ] = $_aLastInputs;
             if ( false !== $_aLastInputs ) {
-                $this->delete();    // deletes at the end of the script.
+                $this->delete(); // deletes at the end of the script.
             }
         }
         

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

Doc Comments +2 added lines

@@ -77,6 +77,8 @@
     }
         /**
          * @since       3.6.0
+         * @param boolean $abCollapsible
+         * @param string $sTitle
          * @return      array
          */
         private function _getArguments( $abCollapsible, $sTitle, array $aSection ) {

Spacing +13 added lines, -13 removed lines

@@ -24,12 +24,12 @@ 
      * @since       3.6.0       Moved from `AdminPageFramework_FormDefinition`.
      */
     static public $aStructure = array(
-        'title'                     => null,        // (string)  the section title will be assigned by default in the section formatting method.
-        'is_collapsed'              => true,        // (boolean) whether it is already collapsed or expanded
-        'toggle_all_button'         => null,        // (boolean|string|array) the position of where to display the toggle-all button that toggles the folding state of all collapsible sections. Accepts the following values. 'top-right', 'top-left', 'bottom-right', 'bottom-left'. If true is passed, the default 'top-right' will be used. To not to display, do not set any or pass `false` or `null`.
-        'collapse_others_on_expand' => true,        // (boolean) whether the other collapsible sections should be folded when the section is unfolded.
-        'container'                 => 'sections',  // (string) the container element that collapsible styling gets applied to. Either 'sections' or 'section' is accepted.
-        'type'                      => 'box',       // 3.7.0+  (string)  supported types 'box', 'button' Default: `box`. The `button` type is only supported when the `container` argument is `section`.
+        'title'                     => null, // (string)  the section title will be assigned by default in the section formatting method.
+        'is_collapsed'              => true, // (boolean) whether it is already collapsed or expanded
+        'toggle_all_button'         => null, // (boolean|string|array) the position of where to display the toggle-all button that toggles the folding state of all collapsible sections. Accepts the following values. 'top-right', 'top-left', 'bottom-right', 'bottom-left'. If true is passed, the default 'top-right' will be used. To not to display, do not set any or pass `false` or `null`.
+        'collapse_others_on_expand' => true, // (boolean) whether the other collapsible sections should be folded when the section is unfolded.
+        'container'                 => 'sections', // (string) the container element that collapsible styling gets applied to. Either 'sections' or 'section' is accepted.
+        'type'                      => 'box', // 3.7.0+  (string)  supported types 'box', 'button' Default: `box`. The `button` type is only supported when the `container` argument is `section`.
     );
     
     public $abCollapsible = false;
@@ -42,7 +42,7 @@ 
      * @remark      The framework will not pass this parameter when formatting a section definition array.
      * It will be passed when the framework is rendering a form table to generate collapsible elements.
      */
-    public $aSection      = array();
+    public $aSection = array();
     
     /**
      * Sets up properties.
@@ -85,14 +85,14 @@ 
             
             $_aCollapsible = $this->getAsArray( $this->abCollapsible ) + array(
                 'title'     => $sTitle,
-            ) +  self::$aStructure;
+            ) + self::$aStructure;
             
             $_aCollapsible[ 'toggle_all_button' ] = implode(
                 ',',
                 $this->getAsArray( $_aCollapsible[ 'toggle_all_button' ] )
             );
             
-            if ( ! empty( $aSection ) ) {
+            if ( !empty( $aSection ) ) {
                 $_aCollapsible[ 'toggle_all_button' ] = $this->_getToggleAllButtonArgument(
                     $_aCollapsible[ 'toggle_all_button' ],
                     $aSection
@@ -116,7 +116,7 @@ 
              */
             private function _getToggleAllButtonArgument( $sToggleAll, array $aSection ) {
                 
-                if ( ! $aSection[ 'repeatable' ] ) {
+                if ( !$aSection[ 'repeatable' ] ) {
                     return $sToggleAll;
                 }
                 
@@ -126,13 +126,13 @@ 
                 }
                 
                 // Disable the toggle all button for middle sub-sections in repeatable sections.
-                if ( ! $aSection[ '_is_first_index' ] && ! $aSection[ '_is_last_index' ] ) {
+                if ( !$aSection[ '_is_first_index' ] && !$aSection[ '_is_last_index' ] ) {
                     return 0;
                 }
                 
                 $_aToggleAll = $this->getAOrB(
-                    true === $sToggleAll || 1 ===  $sToggleAll, // evaluate
-                    array( 'top-right', 'bottom-right' ),   // if true
+                    true === $sToggleAll || 1 === $sToggleAll, // evaluate
+                    array( 'top-right', 'bottom-right' ), // if true
                     explode( ',', $sToggleAll ) // if false
                 );
                 $_aToggleAll = $this->getAOrB(

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

Doc Comments +2 added lines

@@ -98,6 +98,7 @@ 
          * @since       DEVVER      Moved from `AdminPageFramework_FormDefinition`. Changed the name from `formatFields()`.
          * Added the `$aSectionsets` parameter.
          * @retuen      array
+         * @param string $sCapability
          */
         private function _getFieldsetsFormatted( array $aFieldsets, array $aSectionsets, $sCapability ) {
 
@@ -271,6 +272,7 @@ 
              * 
              * @since       3.0.0
              * @since       DEVVER          Moved from `AdminPageFramework_FormDefinition`. Changed the name from `formatField()`.
+             * @param integer $iCountOfElements
              * @return      array|void      An array of formatted field definition array. If required keys are not set, nothing will be returned. 
              */
             private function _getFieldsetFormatted( $aFieldset, $aSectionsets, $sCapability, $iCountOfElements, $iSubSectionIndex, $bIsSectionRepeatable, $oCallerObject ) {

Spacing +13 added lines, -13 removed lines

@@ -103,10 +103,10 @@ 
         private function _getFieldsetsFormatted( array $aFieldsets, array $aSectionsets, $sCapability ) {
 
             $_aNewFieldsets = array();
-            foreach( $aFieldsets as $_sSectionPath => $_aItems ) {
+            foreach ( $aFieldsets as $_sSectionPath => $_aItems ) {
 
                 // If the section is not set, skip.
-                if ( ! isset( $aSectionsets[ $_sSectionPath ] ) ) {
+                if ( !isset( $aSectionsets[ $_sSectionPath ] ) ) {
                     continue;
                 }
 
@@ -115,7 +115,7 @@ 
                     $_aItems,
                     $this->getElement(  // 3.6.0+ Get the section's capability
                         $aSectionsets,
-                        array( $_sSectionPath, 'capability', ),
+                        array( $_sSectionPath, 'capability',),
                         $sCapability
                     ),
                     $aSectionsets
@@ -175,16 +175,16 @@ 
                  */
                 private function _getNormalFieldsetsFormatted( $aItems, $sCapability, $aSectionsets, $_abSectionRepeatable ) {
                     
-                    $_aNewItems     = array();
-                    foreach( $aItems as $_sFieldID => $_aFieldset ) {
+                    $_aNewItems = array();
+                    foreach ( $aItems as $_sFieldID => $_aFieldset ) {
                         
                         // Insert the formatted field definition array. The fields count is needed to set each order value.
-                        $_aFieldset        = $this->_getFieldsetFormatted(
+                        $_aFieldset = $this->_getFieldsetFormatted(
                             $_aFieldset,
                             $aSectionsets,
                             $sCapability,
                             count( $_aNewItems ), // count of elements - zero based
-                            null,   // sub-section index
+                            null, // sub-section index
                             $_abSectionRepeatable,
                             $this->oCallerForm
                         );
@@ -204,7 +204,7 @@ 
                  * @return      boolean
                  */
                 private function _isSubSections( $aItems, $_abSectionRepeatable ) {
-                    if ( ! empty( $_abSectionRepeatable ) ) {
+                    if ( !empty( $_abSectionRepeatable ) ) {
                         return true;
                     }
 
@@ -216,9 +216,9 @@ 
                 private function _getSubSectionsFormatted( $aItems, $sCapability, $aSectionsets, $_abSectionRepeatable ) {
                              
                     $_aNewFieldset = array();
-                    foreach( $this->numerizeElements( $aItems ) as $_iSubSectionIndex => $_aFieldsets ) {
+                    foreach ( $this->numerizeElements( $aItems ) as $_iSubSectionIndex => $_aFieldsets ) {
                                       
-                        foreach( $_aFieldsets as $_aFieldset ) {
+                        foreach ( $_aFieldsets as $_aFieldset ) {
                             $_iCountElement = count( $this->getElementAsArray( $_aNewFieldset, $_iSubSectionIndex ) );
                             $_aFieldset     = $this->_getFieldsetFormatted(
                                 $_aFieldset,
@@ -232,7 +232,7 @@ 
                             if ( empty( $_aFieldset ) ) {
                                 continue;
                             }
-                            $_aNewFieldset[ $_iSubSectionIndex ][ $_aFieldset['field_id'] ] = $_aFieldset;
+                            $_aNewFieldset[ $_iSubSectionIndex ][ $_aFieldset[ 'field_id' ] ] = $_aFieldset;
                         }
                         uasort( $_aNewFieldset[ $_iSubSectionIndex ], array( $this, 'sortArrayByKey' ) );
                         
@@ -260,7 +260,7 @@ 
                 }
                 
                 $_aSortedFields = array();
-                foreach( $aSectionsets as $_sSectionPath => $_aSecitonset ) {
+                foreach ( $aSectionsets as $_sSectionPath => $_aSecitonset ) {
                     if ( isset( $aFieldsets[ $_sSectionPath ] ) ) {
                         $_aSortedFields[ $_sSectionPath ] = $aFieldsets[ $_sSectionPath ];
                     }
@@ -278,7 +278,7 @@ 
              */
             private function _getFieldsetFormatted( $aFieldset, $aSectionsets, $sCapability, $iCountOfElements, $iSubSectionIndex, $bIsSectionRepeatable, $oCallerObject ) {
 
-                if ( ! isset( $aFieldset[ 'field_id' ], $aFieldset[ 'type' ] ) ) {
+                if ( !isset( $aFieldset[ 'field_id' ], $aFieldset[ 'type' ] ) ) {
                     return;
                 }
 

development/factory/_common/form/_view/attribute/AdminPageFramework_Form_View___Attribute_Field.php

Doc Comments -1 removed lines

@@ -30,7 +30,6 @@
      * Returns the field container attribute array.
      * 
      * @remark      Formatting each sub-field should be performed prior to callign this method.
-     * @param       array       $aField     The (sub-)field definition array. This should have been formatted already.
      * @return      array       The generated field container attribute array.
      * @internal   
      * @since       3.5.3

Indentation +6 added lines, -6 removed lines

@@ -1,11 +1,11 @@
 <?php
 /**
- * Admin Page Framework
- * 
- * http://en.michaeluno.jp/admin-page-framework/
- * Copyright (c) 2013-2016 Michael Uno; Licensed MIT
- * 
- */
+         * Admin Page Framework
+         * 
+         * http://en.michaeluno.jp/admin-page-framework/
+         * Copyright (c) 2013-2016 Michael Uno; Licensed MIT
+         * 
+         */
 
 /**
  * Provides utility methods which can be accessed among different components of the framework.

Spacing +3 added lines, -3 removed lines

@@ -24,7 +24,7 @@ 
      * 
      * @since       3.6.0
      */
-    public $sContext    = 'field';
+    public $sContext = 'field';
 
     /**
      * Returns the field container attribute array.
@@ -41,10 +41,10 @@ 
 
         return array(
             'id'            => $this->aArguments[ '_field_container_id' ],
-            'data-type'     => $this->aArguments[ 'type' ],   // referred by the repeatable field JavaScript script.
+            'data-type'     => $this->aArguments[ 'type' ], // referred by the repeatable field JavaScript script.
             // @deprecated 3.6.0 
             // 'data-id_model' => $this->aArguments[ '_fields_container_id_model' ], // 3.3.1+
-            'class'         => "admin-page-framework-field admin-page-framework-field-" . $this->aArguments[ 'type' ]
+            'class'         => "admin-page-framework-field admin-page-framework-field-".$this->aArguments[ 'type' ]
                 . $this->getAOrB(
                     $this->aArguments[ 'attributes' ][ 'disabled' ],
                     ' disabled',

development/factory/_common/form/_view/fieldset/AdminPageFramework_Form_View___Fieldset___FieldError.php

Doc Comments +1 added lines

@@ -60,6 +60,7 @@
          * 
          * @since       3.1.0
          * @since       DEVVER      Moved from `AdminPageFramework_Form_View___Fieldset`.
+         * @param string $sHeadingMessage
          * @return      string      The error string message. An empty value if not found.
          */
         private function _getFieldError( $aErrors, $aSectionPath, $aFieldPath, $sHeadingMessage ) {

Spacing +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
         private function _getFieldError( $aErrors, $aSectionPath, $aFieldPath, $sHeadingMessage ) {
 
             // If this field has a section and the error element is set
-            $_aErrorPath   = array_merge( $aSectionPath, $aFieldPath );
+            $_aErrorPath = array_merge( $aSectionPath, $aFieldPath );
             if ( $this->_hasFieldError( $aErrors, $_aErrorPath ) ) {
                 return "<span class='field-error'>*&nbsp;"
                         . $sHeadingMessage

development/factory/_common/form/_view/fieldset/AdminPageFramework_Form_View___Fieldset_Base.php

Doc Comments +2 added lines

@@ -176,6 +176,7 @@ 
      * Returns the repeatable fields script.
      * 
      * @since 2.1.3
+     * @param string $sFieldsContainerID
      */
     protected function _getRepeaterFieldEnablerScript( $sFieldsContainerID, $iFieldCount, $aSettings ) {
 
@@ -222,6 +223,7 @@ 
      * Returns the sortable fields script.
      * 
      * @since 3.0.0
+     * @param string $sFieldsContainerID
      */    
     protected function _getSortableFieldEnablerScript( $sFieldsContainerID ) {        
     

Indentation +1 added lines, -1 removed lines

@@ -189,7 +189,7 @@
         $_sButtons              = 
             "<div class='admin-page-framework-repeatable-field-buttons' {$_sSettingsAttributes} >"
                 . "<a class='repeatable-field-remove-button button-secondary repeatable-field-button button button-small {$_sDashiconMinus}' href='#' title='{$_sRemove}' {$_sVisibility} data-id='{$sFieldsContainerID}'>"
-                  . ( $_bDashiconSupported ? '' : '-' )
+                    . ( $_bDashiconSupported ? '' : '-' )
                 . "</a>"
                 . "<a class='repeatable-field-add-button button-secondary repeatable-field-button button button-small {$_sDashiconPlus}' href='#' title='{$_sAdd}' data-id='{$sFieldsContainerID}'>" 
                     . ( $_bDashiconSupported ? '' : '+' )

Spacing +10 added lines, -10 removed lines

@@ -68,7 +68,7 @@ 
      * @param       object      $oMsg                   An object storing the system messages.
      * @param       array       $aCallbacks             An array storing the form-field specific callbacks.     
      */
-    public function __construct( &$aField, $aOptions, $aErrors, &$aFieldTypeDefinitions, &$oMsg, array $aCallbacks=array() ) {
+    public function __construct( &$aField, $aOptions, $aErrors, &$aFieldTypeDefinitions, &$oMsg, array $aCallbacks = array() ) {
 
         // @todo Investigate why the first parameter is passed by reference. 
 
@@ -79,13 +79,13 @@ 
         $this->aErrors                  = $this->getAsArray( $aErrors );
         $this->oMsg                     = $oMsg;
         $this->aCallbacks               = $aCallbacks + array(
-            'hfID'              => null,    // the input id attribute
-            'hfTagID'           => null,    // the fieldset/field row container id attribute
-            'hfName'            => null,    // the input name attribute
-            'hfNameFlat'        => null,    // the flat input name attribute                
+            'hfID'              => null, // the input id attribute
+            'hfTagID'           => null, // the fieldset/field row container id attribute
+            'hfName'            => null, // the input name attribute
+            'hfNameFlat'        => null, // the flat input name attribute                
             'hfInputName'       => null,
             'hfInputNameFlat'   => null,
-            'hfClass'           => null,    // the class attribute
+            'hfClass'           => null, // the class attribute
         );        
         
         // 2. Load necessary JavaScript scripts.
@@ -152,9 +152,9 @@ 
          * @since   3.2.0   Added the `$sFieldsType` parameter.
          * @internal
          */
-        private function _loadScripts( $sStructureType='' ) {
+        private function _loadScripts( $sStructureType = '' ) {
 
-            if ( 'widget' === $sStructureType && ! self::$_bIsLoadedSScripts_Widget ) {
+            if ( 'widget' === $sStructureType && !self::$_bIsLoadedSScripts_Widget ) {
                 new AdminPageFramework_Form_View___Script_Widget;
                 self::$_bIsLoadedSScripts_Widget = true;
             }
@@ -183,7 +183,7 @@ 
         $_sRemove               = $this->oMsg->get( 'remove' );
         $_sVisibility           = $iFieldCount <= 1 ? " style='visibility: hidden;'" : "";
         $_sSettingsAttributes   = $this->generateDataAttributes( ( array ) $aSettings );
-        $_bDashiconSupported    = false;     // version_compare( $GLOBALS['wp_version'], '3.8', '>=' );
+        $_bDashiconSupported    = false; // version_compare( $GLOBALS['wp_version'], '3.8', '>=' );
         $_sDashiconPlus         = $_bDashiconSupported ? 'dashicons dashicons-plus' : '';
         $_sDashiconMinus        = $_bDashiconSupported ? 'dashicons dashicons-minus' : '';
         $_sButtons              = 
@@ -196,7 +196,7 @@ 
                 . "</a>"                
             . "</div>";
         $_aJSArray              = json_encode( $aSettings );
-        $_sButtonsHTML          = '"' . $_sButtons . '"';
+        $_sButtonsHTML          = '"'.$_sButtons.'"';
         $_sScript               = <<<JAVASCRIPTS
 jQuery( document ).ready( function() {
     var _nodePositionIndicators = jQuery( '#{$sFieldsContainerID} .admin-page-framework-field .repeatable-field-buttons' );

development/factory/_common/form/_view/generator/field/AdminPageFramework_Form_View___Generate_Field_Base.php

Doc Comments -1 removed lines

@@ -23,7 +23,6 @@
      * @internal
      * @since       3.5.3
      * @since       3.6.0       Moved from `AdminPageFramework_FormDefinition`.
-     * @param       array       $aFieldset     a field definition array.
      * @return      boolean
      */
     protected function _isSectionSet() {

development/factory/_common/form/_view/generator/field/AdminPageFramework_Form_View___Generate_FieldInputName.php

Doc Comments +1 added lines

@@ -60,6 +60,7 @@
         /**
          * Applies the subject string to the set callback filter function.
          * @since       3.6.0
+         * @param string $sSubject
          */
         protected function _getFiltered( $sSubject ) {
             return is_callable( $this->hfCallback )

Spacing +2 added lines, -2 removed lines

@@ -51,9 +51,9 @@
         $_sIndex = $this->getAOrB(
             '0' !== $this->sIndex && empty( $this->sIndex ),
             '',
-            "[" . $this->sIndex . "]"
+            "[".$this->sIndex."]"
         );        
-        return $this->_getFiltered( $this->_getFieldName() . $_sIndex );
+        return $this->_getFiltered( $this->_getFieldName().$_sIndex );
         
     }
     

development/factory/_common/form/_view/generator/section/AdminPageFramework_Form_View___Generate_Section_Base.php

Doc Comments +1 added lines

@@ -51,6 +51,7 @@
     /**
      * Applies the subject string to the set callback filter function.
      * @since       3.6.0
+     * @param string $sSubject
      */
     protected function _getFiltered( $sSubject ) {
         return is_callable( $this->hfCallback )

Spacing +3 added lines, -3 removed lines

@@ -35,7 +35,7 @@ 
             $this->hfCallback,
         );
         $this->aArguments = $_aParameters[ 0 ];        
-        $this->hfCallback  = $_aParameters[ 1 ];
+        $this->hfCallback = $_aParameters[ 1 ];
 
     }    
     
@@ -83,8 +83,8 @@ 
         
         // Extract the first part as it does not have braces
         $_sName = array_shift( $aParts );
-        foreach( $aParts as $_sPart ) {
-            $_sName .= '[' . $_sPart . ']';
+        foreach ( $aParts as $_sPart ) {
+            $_sName .= '['.$_sPart.']';
         }
         return $_sName;