michaeluno / admin-page-framework

development/factory/admin_page/_model/delegate/validaor/AdminPageFramework_Model__FormSubmission__Validator__Export.php

Doc Comments +2 added lines

@@ -91,6 +91,7 @@ 
              *
              * @since       3.5.4
              * @since       3.6.3       Moved from `AdminPageFramework_Form_Model_Export`.
+             * @param string $sFileName
              * @return      array
              */
             private function _getExportHeaderArray( array $aArguments, $sFileName, $mData ) {
@@ -131,6 +132,7 @@ 
              * @since       3.5.3
              * @since       3.6.3       Moved from `AdminPageFramework_Form_Model_Export`.
              * @internal
+             * @param string $mData
              * @return      string      The export file name.
              */
             private function _getExportFileName( array $aArguments, $sExportFileName, $mData ) {

Spacing +4 added lines, -4 removed lines

@@ -32,7 +32,7 @@ 
      */
     public function _replyToCallback( $aInputs, $aRawInputs, array $aSubmits, $aSubmitInformation, $oFactory ) {
 
-        if ( ! $this->_shouldProceed() ) {
+        if ( !$this->_shouldProceed() ) {
             return;
         }
         $this->_exportOptions(
@@ -67,11 +67,11 @@ 
          */
         protected function _exportOptions( $mData, $sPageSlug, $sTabSlug ) {
 
-            $_oExport           = new AdminPageFramework_ExportOptions(
+            $_oExport = new AdminPageFramework_ExportOptions(
                 $this->getHTTPRequestSanitized( $this->getElementAsArray( $_POST, array( '__export' ) ), true ),
                 $this->oFactory->oProp->sClassName
             );
-            $_aArguments        = array(
+            $_aArguments = array(
                 'class_name'        => $this->oFactory->oProp->sClassName,
                 'page_slug'         => $sPageSlug,
                 'tab_slug'          => $sTabSlug,
@@ -143,7 +143,7 @@ 
                     $sExportFileName,
                     $aArguments[ 'pressed_field_id' ],
                     $aArguments[ 'pressed_input_id' ],
-                    $mData,     // 3.4.6+
+                    $mData, // 3.4.6+
                     $this->oFactory       // 3.4.6+
                 );
             }

development/factory/admin_page/_model/delegate/validaor/AdminPageFramework_Model__FormSubmission__Validator__Import.php

Doc Comments +4 added lines

@@ -142,6 +142,7 @@ 
                 /**
                  * Sets update admin notice.
                  * @since       3.5.3
+                 * @param boolean $bEmpty
                  * @return      void
                  */
                 private function _setImportAdminNotice( $bEmpty ) {
@@ -209,6 +210,8 @@ 
                  * @since       3.5.3
                  * @since       3.6.3       Moved from `AdminPageFramework_Form_Model_Import`.
                  * @internal
+                 * @param string $sFormatType
+                 * @param string $sImportOptionKey
                  * @return      string      The filtered import data.
                  */
                 private function _getFilteredImportData( array $aArguments, $mData, $aStoredOptions, $sFormatType, $sImportOptionKey ) {
@@ -237,6 +240,7 @@ 
      * @param       string      The filter prefix.
      * @param       mixed       The subject filtering value.
      * @param       array       An argument array holding submit information. Part of this will be passed to the filter callbacks but this itself does not mean is for the filter callbacks.
+     * @param string $sPrefix
      */
     protected function _getFilteredItemForPortByPrefix( $sPrefix, $mFilteringValue, array $aArguments ) {
         return $this->addAndApplyFilters(

Spacing +15 added lines, -15 removed lines

@@ -35,7 +35,7 @@ 
      * @since       3.6.3
      */
     public function _replyToCallback( $aInputs, $aRawInputs, array $aSubmits, $aSubmitInformation, $oFactory ) {
-        if ( ! $this->_shouldProceed() ) {
+        if ( !$this->_shouldProceed() ) {
             return;
         }
         $this->_doImportOptions(
@@ -93,11 +93,11 @@ 
              */
             private function _importOptions( $aStoredOptions, $sPageSlug, $sTabSlug ) {
 
-                $_oImport           = new AdminPageFramework_ImportOptions(
+                $_oImport = new AdminPageFramework_ImportOptions(
                     $this->getHTTPRequestSanitized( $_FILES[ '__import' ], false ),
                     $this->getHTTPRequestSanitized( $_POST[ '__import' ], true )
                 );
-                $_aArguments        = array(
+                $_aArguments = array(
                     'class_name'        => $this->oFactory->oProp->sClassName,
                     'page_slug'         => $sPageSlug,
                     'tab_slug'          => $sTabSlug,
@@ -116,9 +116,9 @@ 
                 // Check the uploaded file MIME type.
                 $_aMIMEType = $this->_getImportMIMEType( $_aArguments );
                 $_sType     = $_oImport->getType();
-                if ( ! in_array( $_sType, $_aMIMEType ) ) {
+                if ( !in_array( $_sType, $_aMIMEType ) ) {
                     $this->oFactory->setSettingNotice( sprintf( $this->oFactory->oMsg->get( 'uploaded_file_type_not_supported' ), $_sType ) );
-                    return $aStoredOptions;        // do not change the framework's options.
+                    return $aStoredOptions; // do not change the framework's options.
                 }
 
                 // Retrieve the importing data.
@@ -183,9 +183,9 @@ 
                         array(
                             'text/plain',
                             'application/octet-stream', // .json file is dealt as a binary file.
-                            'application/json',         // 3.7.0+ some servers cannot upload json files without this
-                            'text/html',                // 3.7.2+
-                            'application/txt',          // 3.7.2+
+                            'application/json', // 3.7.0+ some servers cannot upload json files without this
+                            'text/html', // 3.7.2+
+                            'application/txt', // 3.7.2+
                         ),
                         $aArguments
                     );
@@ -274,18 +274,18 @@ 
     protected function _getPortFilterHookNames( $sPrefix, array $aArguments ) {
 
         return array(
-            $sPrefix . $aArguments[ 'class_name' ] . '_' . $aArguments[ 'pressed_input_id' ],
+            $sPrefix.$aArguments[ 'class_name' ].'_'.$aArguments[ 'pressed_input_id' ],
             $aArguments[ 'section_id' ]
-                ? $sPrefix . $aArguments[ 'class_name' ] . '_' . $aArguments[ 'section_id' ] .'_' . $aArguments[ 'pressed_field_id' ]
-                : $sPrefix . $aArguments[ 'class_name' ] . '_' . $aArguments[ 'pressed_field_id' ],
+                ? $sPrefix.$aArguments[ 'class_name' ].'_'.$aArguments[ 'section_id' ].'_'.$aArguments[ 'pressed_field_id' ]
+                : $sPrefix.$aArguments[ 'class_name' ].'_'.$aArguments[ 'pressed_field_id' ],
             $aArguments[ 'section_id' ]
-                ? $sPrefix . $aArguments[ 'class_name' ] . '_' . $aArguments[ 'section_id' ]
+                ? $sPrefix.$aArguments[ 'class_name' ].'_'.$aArguments[ 'section_id' ]
                 : null,
             $aArguments[ 'tab_slug' ]
-                ? $sPrefix . $aArguments[ 'page_slug' ] . '_' . $aArguments[ 'tab_slug' ]
+                ? $sPrefix.$aArguments[ 'page_slug' ].'_'.$aArguments[ 'tab_slug' ]
                 : null,
-            $sPrefix . $aArguments[ 'page_slug' ],
-            $sPrefix . $aArguments[ 'class_name' ]
+            $sPrefix.$aArguments[ 'page_slug' ],
+            $sPrefix.$aArguments[ 'class_name' ]
         );
 
     }

development/factory/admin_page/_model/delegate/validaor/AdminPageFramework_Model__FormSubmission__Validator__Redirect.php

Doc Comments +1 added lines

@@ -65,6 +65,7 @@
          * Sets the given URL's transient.
          * @since       unknown
          * @since       3.6.3       Moved from `AdminPageFramework_Validation`.
+         * @param string $sURL
          */
         private function _setRedirectTransients( $sURL, $sPageSlug ) {
             if ( empty( $sURL ) ) {

Spacing +3 added lines, -3 removed lines

@@ -34,7 +34,7 @@ 
             $aSubmits,
             'redirect_url'
         );
-        if ( ! $_sRedirectURL ) {
+        if ( !$_sRedirectURL ) {
             return;
         }
 
@@ -70,8 +70,8 @@ 
             if ( empty( $sURL ) ) {
                 return;
             }
-            $_sTransient = 'apf_rurl' . md5( trim( "redirect_{$this->oFactory->oProp->sClassName}_{$sPageSlug}" ) );
-            return $this->setTransient( $_sTransient, $sURL , 60*2 );
+            $_sTransient = 'apf_rurl'.md5( trim( "redirect_{$this->oFactory->oProp->sClassName}_{$sPageSlug}" ) );
+            return $this->setTransient( $_sTransient, $sURL, 60 * 2 );
         }
 
 }

development/factory/admin_page/_model/delegate/validaor/AdminPageFramework_Model__FormSubmission__Validator__Reset.php

Doc Comments +1 added lines

@@ -71,6 +71,7 @@
          * @since       3.6.3       Moved from `AdminPageFramework_Validation`.
          * @remark      `$aInputs` has only the page elements that called the validation callback.
          * In other words, it does not hold other pages' option keys.
+         * @param string $sKeyToReset
          * @return      array       The modified input array.
          */
         private function _resetOptions( $sKeyToReset, array $aInputs, array $aSubmitInformation ) {

Spacing +5 added lines, -5 removed lines

@@ -34,7 +34,7 @@ 
      */
     public function _replyToCallback( $aInputs, $aRawInputs, array $aSubmits, $aSubmitInformation, $oFactory ) {
 
-        if ( ! $this->_shouldProceed( $oFactory, $aSubmits ) ) {
+        if ( !$this->_shouldProceed( $oFactory, $aSubmits ) ) {
             return;
         }
 
@@ -44,7 +44,7 @@ 
             'reset_key'
         );
         $_sKeyToReset = trim( $_sKeyToReset );
-        if ( ! $_sKeyToReset ) {
+        if ( !$_sKeyToReset ) {
             return;
         }
         $_oException = new Exception( 'aReturn' );
@@ -61,7 +61,7 @@ 
          * @return      boolean
          */
         protected function _shouldProceed( $oFactory, $aSubmits ) {
-            return ! $oFactory->hasFieldError();
+            return !$oFactory->hasFieldError();
         }
 
         /**
@@ -79,12 +79,12 @@ 
             $this->_doResetActions( $sKeyToReset, $aInputs, $aSubmitInformation );
 
             // As of 3.1.0, an empty value is accepted for the option key.
-            if ( ! $this->oFactory->oProp->sOptionKey ) {
+            if ( !$this->oFactory->oProp->sOptionKey ) {
                 return array();
             }
 
             // The key to delete is not specified, 1 is sent from the form input.
-            if ( in_array( $sKeyToReset, array( '1', ), true ) ) {
+            if ( in_array( $sKeyToReset, array( '1',), true ) ) {
                 delete_option( $this->oFactory->oProp->sOptionKey );
                 return array();
             }

development/factory/admin_page/AdminPageFramework_Controller.php

Doc Comments +5 added lines

@@ -233,6 +233,7 @@ 
     * @param        string      the tagged HTML link text.
     * @param        string      (optional) another tagged HTML link text.
     * @param        string      (optional) add more as many as want by adding items to the next parameters.
+    * @param string $sTaggedLinkHTML1
     * @access       public
     * @return       void
     */
@@ -258,6 +259,9 @@ 
     * @param        string      the tagged HTML link text.
     * @param        string      (optional) another tagged HTML link text.
     * @param        string      (optional) add more as many as want by adding items to the next parameters.
+    * @param null|string $sTaggedLinkHTML1
+    * @param string $sTaggedLinkHTML2
+    * @param string $_and_more
     * @access       public
     * @return       void
     */
@@ -277,6 +281,7 @@ 
      *
      * @since       3.1.0
      * @since       3.3.1       Moved from `AdminPageFramework`.
+     * @param string $sLabel
      */
     public function setPluginSettingsLinkLabel( $sLabel ) {
         $this->oProp->sLabelPluginSettingsLink = $sLabel;

Indentation +35 added lines, -35 removed lines

@@ -218,24 +218,24 @@ 
     }
 
     /**
-    * Adds the given link(s) into the description cell of the plugin listing table.
-    *
-    * <h4>Example</h4>
-    * <code>$this->addLinkToPluginDescription(
-    *       "<a href='http://www.google.com'>Google</a>",
-    *       "<a href='http://www.yahoo.com'>Yahoo!</a>"
-    * );</code>
-    *
-    * @since        2.0.0
-    * @since        3.0.0       Changed the scope to public from protected.
-    * @since        3.3.1       Moved from `AdminPageFramework`.
-    * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-    * @param        string      the tagged HTML link text.
-    * @param        string      (optional) another tagged HTML link text.
-    * @param        string      (optional) add more as many as want by adding items to the next parameters.
-    * @access       public
-    * @return       void
-    */
+     * Adds the given link(s) into the description cell of the plugin listing table.
+     *
+     * <h4>Example</h4>
+     * <code>$this->addLinkToPluginDescription(
+     *       "<a href='http://www.google.com'>Google</a>",
+     *       "<a href='http://www.yahoo.com'>Yahoo!</a>"
+     * );</code>
+     *
+     * @since        2.0.0
+     * @since        3.0.0       Changed the scope to public from protected.
+     * @since        3.3.1       Moved from `AdminPageFramework`.
+     * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
+     * @param        string      the tagged HTML link text.
+     * @param        string      (optional) another tagged HTML link text.
+     * @param        string      (optional) add more as many as want by adding items to the next parameters.
+     * @access       public
+     * @return       void
+     */
     public function addLinkToPluginDescription( $sTaggedLinkHTML1, $sTaggedLinkHTML2=null, $_and_more=null ) {
         if ( 'plugins.php' !== $this->oProp->sPageNow ) {
             return;
@@ -244,23 +244,23 @@ 
     }
 
     /**
-    * Adds the given link(s) into the title cell of the plugin listing table.
-    *
-    * <h4>Example</h4>
-    * <code>$this->addLinkToPluginTitle(
-    *       "<a href='http://www.wordpress.org'>WordPress</a>"
-    * );</code>
-    *
-    * @since        2.0.0
-    * @since        3.0.0       Changed the scope to public from protected.
-    * @since        3.3.1       Moved from `AdminPageFramework`.
-    * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-    * @param        string      the tagged HTML link text.
-    * @param        string      (optional) another tagged HTML link text.
-    * @param        string      (optional) add more as many as want by adding items to the next parameters.
-    * @access       public
-    * @return       void
-    */
+     * Adds the given link(s) into the title cell of the plugin listing table.
+     *
+     * <h4>Example</h4>
+     * <code>$this->addLinkToPluginTitle(
+     *       "<a href='http://www.wordpress.org'>WordPress</a>"
+     * );</code>
+     *
+     * @since        2.0.0
+     * @since        3.0.0       Changed the scope to public from protected.
+     * @since        3.3.1       Moved from `AdminPageFramework`.
+     * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
+     * @param        string      the tagged HTML link text.
+     * @param        string      (optional) another tagged HTML link text.
+     * @param        string      (optional) add more as many as want by adding items to the next parameters.
+     * @access       public
+     * @return       void
+     */
     public function addLinkToPluginTitle( $sTaggedLinkHTML1, $sTaggedLinkHTML2=null, $_and_more=null ) {
 
         if ( 'plugins.php' !== $this->oProp->sPageNow ) {

Spacing +10 added lines, -10 removed lines

@@ -114,7 +114,7 @@ 
      * @param       array       $aCustomArgs    (optional) The argument array for more advanced parameters.
      * @return      array       The array holing the queued items.
      */
-    public function enqueueStyles( $aSRCs, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {
+    public function enqueueStyles( $aSRCs, $sPageSlug = '', $sTabSlug = '', $aCustomArgs = array() ) {
         return $this->oResource->_enqueueStyles( $aSRCs, $sPageSlug, $sTabSlug, $aCustomArgs );
     }
     /**
@@ -149,7 +149,7 @@ 
      * </ul>
      * @return      string      The style handle ID. If the passed url is not a valid url string, an empty string will be returned.
      */
-    public function enqueueStyle( $sSRC, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {
+    public function enqueueStyle( $sSRC, $sPageSlug = '', $sTabSlug = '', $aCustomArgs = array() ) {
         return $this->oResource->_enqueueStyle( $sSRC, $sPageSlug, $sTabSlug, $aCustomArgs );
     }
     /**
@@ -174,7 +174,7 @@ 
      * @param       array       (optional) The argument array for more advanced parameters.
      * @return      array        The array holding the queued items.
      */
-    public function enqueueScripts( $aSRCs, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {
+    public function enqueueScripts( $aSRCs, $sPageSlug = '', $sTabSlug = '', $aCustomArgs = array() ) {
         return $this->oResource->_enqueueScripts( $aSRCs, $sPageSlug, $sTabSlug, $aCustomArgs );
     }
     /**
@@ -213,7 +213,7 @@ 
      * </ul>
      * @return      string      The script handle ID. If the passed url is not a valid url string, an empty string will be returned.
      */
-    public function enqueueScript( $sSRC, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {
+    public function enqueueScript( $sSRC, $sPageSlug = '', $sTabSlug = '', $aCustomArgs = array() ) {
         return $this->oResource->_enqueueScript( $sSRC, $sPageSlug, $sTabSlug, $aCustomArgs );
     }
 
@@ -236,7 +236,7 @@ 
     * @access       public
     * @return       void
     */
-    public function addLinkToPluginDescription( $sTaggedLinkHTML1, $sTaggedLinkHTML2=null, $_and_more=null ) {
+    public function addLinkToPluginDescription( $sTaggedLinkHTML1, $sTaggedLinkHTML2 = null, $_and_more = null ) {
         if ( 'plugins.php' !== $this->oProp->sPageNow ) {
             return;
         }
@@ -261,7 +261,7 @@ 
     * @access       public
     * @return       void
     */
-    public function addLinkToPluginTitle( $sTaggedLinkHTML1, $sTaggedLinkHTML2=null, $_and_more=null ) {
+    public function addLinkToPluginTitle( $sTaggedLinkHTML1, $sTaggedLinkHTML2 = null, $_and_more = null ) {
 
         if ( 'plugins.php' !== $this->oProp->sPageNow ) {
             return;
@@ -320,7 +320,7 @@ 
      * @param       string      (optional) The class selector used in the message HTML element. 'error' and 'updated' are prepared by WordPress but it's not limited to them and can pass a custom name. Default: 'error'.
      * @param       string      (optional) The ID of the message. If not set, the hash of the message will be used.
      */
-    public function setAdminNotice( $sMessage, $sClassSelector='error', $sID='' ) {
+    public function setAdminNotice( $sMessage, $sClassSelector = 'error', $sID = '' ) {
 
         $sID = $sID ? $sID : md5( $sMessage );
 
@@ -357,9 +357,9 @@ 
      * @param       boolean         If true, the passed key(s) will be appended to the property; otherwise, it will override the property.
      * @return      void
      */
-    public function setDisallowedQueryKeys( $asQueryKeys, $bAppend=true ) {
+    public function setDisallowedQueryKeys( $asQueryKeys, $bAppend = true ) {
 
-        if ( ! $bAppend ) {
+        if ( !$bAppend ) {
             $this->oProp->aDisallowedQueryKeys = ( array ) $asQueryKeys;
             return;
         }
@@ -402,7 +402,7 @@ 
      * @param       mixed       $vDefault       the default value that will be returned if nothing is stored.
      * @return      mixed       If the field ID is not specified
      */
-    static public function getOption( $sOptionKey, $asKey=null, $vDefault=null ) {
+    static public function getOption( $sOptionKey, $asKey = null, $vDefault = null ) {
         return AdminPageFramework_WPUtility::getOption( $sOptionKey, $asKey, $vDefault );
     }
 

development/factory/admin_page/AdminPageFramework_Controller_Form.php

Doc Comments -3 removed lines

@@ -193,9 +193,6 @@
     * @since        3.5.3       Removed the parameter declarations as they are caught with the func_get_args().
     * @access       public
     * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-    * @param        string      $sSectionID1        the section ID to remove.
-    * @param        string      $sSectionID2        (optional) another section ID to remove.
-    * @param        string      $_and_more          (optional) add more section IDs to the next parameters as many as necessary.
     * @return       void
     */
     public function removeSettingSections( /* $sSectionID1=null, $sSectionID2=null, $_and_more=null */ ) {

Indentation +45 added lines, -45 removed lines

@@ -180,24 +180,24 @@ 
         }
 
     /**
-    * Removes the given section(s) by section ID.
-    *
-    * This accesses the property storing the added section arrays and removes the specified ones.
-    *
-    * <h4>Example</h4>
-    * <code>$this->removeSettingSections( 'text_fields', 'selectors', 'another_section', 'yet_another_section' );
-    * </code>
-    *
-    * @since        2.0.0
-    * @since        3.0.0       Changed the scope to public from protected.
-    * @since        3.5.3       Removed the parameter declarations as they are caught with the func_get_args().
-    * @access       public
-    * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-    * @param        string      $sSectionID1        the section ID to remove.
-    * @param        string      $sSectionID2        (optional) another section ID to remove.
-    * @param        string      $_and_more          (optional) add more section IDs to the next parameters as many as necessary.
-    * @return       void
-    */
+     * Removes the given section(s) by section ID.
+     *
+     * This accesses the property storing the added section arrays and removes the specified ones.
+     *
+     * <h4>Example</h4>
+     * <code>$this->removeSettingSections( 'text_fields', 'selectors', 'another_section', 'yet_another_section' );
+     * </code>
+     *
+     * @since        2.0.0
+     * @since        3.0.0       Changed the scope to public from protected.
+     * @since        3.5.3       Removed the parameter declarations as they are caught with the func_get_args().
+     * @access       public
+     * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
+     * @param        string      $sSectionID1        the section ID to remove.
+     * @param        string      $sSectionID2        (optional) another section ID to remove.
+     * @param        string      $_and_more          (optional) add more section IDs to the next parameters as many as necessary.
+     * @return       void
+     */
     public function removeSettingSections( /* $sSectionID1=null, $sSectionID2=null, $_and_more=null */ ) {
         foreach( func_get_args() as $_sSectionID ) {
             $this->oForm->removeSection( $_sSectionID );
@@ -262,38 +262,38 @@ 
         }
     }
     /**
-    * Adds the given field array items into the field array property.
-    *
-    * Identical to the `addSettingFields()` method except that this method does not accept enumerated parameters.
-    *
-    * @since        2.1.2
-    * @since        3.0.0           Changed the scope to public from protected.
-    * @access       public
-    * @param        array|string    $asField        the field array or the target section ID. If the target section ID is set, the section_id key can be omitted from the next passing field array.
-    * @return       void
-    */
+     * Adds the given field array items into the field array property.
+     *
+     * Identical to the `addSettingFields()` method except that this method does not accept enumerated parameters.
+     *
+     * @since        2.1.2
+     * @since        3.0.0           Changed the scope to public from protected.
+     * @access       public
+     * @param        array|string    $asField        the field array or the target section ID. If the target section ID is set, the section_id key can be omitted from the next passing field array.
+     * @return       void
+     */
     public function addSettingField( $asField ) {
         $this->oForm->addField( $asField );
     }
 
     /**
-    * Removes the given field(s) by field ID.
-    *
-    * This accesses the property storing the added field arrays and removes the specified ones.
-    *
-    * <h4>Example</h4>
-    * <code>$this->removeSettingFields( 'fieldID_A', 'fieldID_B', 'fieldID_C', 'fieldID_D' );
-    * </code>
-    *
-    * @since        2.0.0
-    * @since        3.0.0       Changed the scope to public from protected.
-    * @access       public
-    * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-    * @param        string      $sFieldID1      the field ID to remove.
-    * @param        string      $sFieldID2      (optional) another field ID to remove.
-    * @param        string      $_and_more      (optional) add more field IDs to the next parameters as many as necessary.
-    * @return void
-    */
+     * Removes the given field(s) by field ID.
+     *
+     * This accesses the property storing the added field arrays and removes the specified ones.
+     *
+     * <h4>Example</h4>
+     * <code>$this->removeSettingFields( 'fieldID_A', 'fieldID_B', 'fieldID_C', 'fieldID_D' );
+     * </code>
+     *
+     * @since        2.0.0
+     * @since        3.0.0       Changed the scope to public from protected.
+     * @access       public
+     * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
+     * @param        string      $sFieldID1      the field ID to remove.
+     * @param        string      $sFieldID2      (optional) another field ID to remove.
+     * @param        string      $_and_more      (optional) add more field IDs to the next parameters as many as necessary.
+     * @return void
+     */
     public function removeSettingFields( $sFieldID1, $sFieldID2=null, $_and_more ) {
         foreach( func_get_args() as $_sFieldID ) {
             $this->oForm->removeField( $_sFieldID );

Spacing +17 added lines, -17 removed lines

@@ -84,7 +84,7 @@ 
      */
     public function addSettingSections( /* $aSection1, $aSection2=null, $_and_more=null */ ) {
 
-        foreach( func_get_args() as $asSection ) {
+        foreach ( func_get_args() as $asSection ) {
             $this->addSettingSection( $asSection );
         }
 
@@ -107,7 +107,7 @@ 
      */
     public function addSettingSection( $asSection ) {
 
-        if ( ! is_array( $asSection ) ) {
+        if ( !is_array( $asSection ) ) {
             $this->_sTargetPageSlug = is_string( $asSection )
                 ? $asSection
                 : $this->_sTargetPageSlug;
@@ -129,10 +129,10 @@ 
             )
         );
 
-        $aSection[ 'section_tab_slug' ]   = $this->oUtil->sanitizeSlug( $aSection[ 'section_tab_slug' ] );
+        $aSection[ 'section_tab_slug' ] = $this->oUtil->sanitizeSlug( $aSection[ 'section_tab_slug' ] );
 
         // A page slug is required.
-        if ( ! $aSection[ 'page_slug' ] ) {
+        if ( !$aSection[ 'page_slug' ] ) {
             return;
         }
         $this->oForm->addSection( $aSection );
@@ -148,8 +148,8 @@ 
         private function _getTargetPageSlug( $aSection ) {
 
             $_sTargetPageSlug = $this->oUtil->getElement(
-                $aSection,      // subject
-                'page_slug',    // key
+                $aSection, // subject
+                'page_slug', // key
                 $this->_sTargetPageSlug     // default
             );
 
@@ -169,8 +169,8 @@ 
          */
         private function _getTargetTabSlug( $aSection ) {
             $_sTargetTabSlug = $this->oUtil->getElement(
-                $aSection,              // subject
-                'tab_slug',             // key
+                $aSection, // subject
+                'tab_slug', // key
                 $this->_sTargetTabSlug  // default
             );
             $_sTargetTabSlug = $_sTargetTabSlug
@@ -199,7 +199,7 @@ 
     * @return       void
     */
     public function removeSettingSections( /* $sSectionID1=null, $sSectionID2=null, $_and_more=null */ ) {
-        foreach( func_get_args() as $_sSectionID ) {
+        foreach ( func_get_args() as $_sSectionID ) {
             $this->oForm->removeSection( $_sSectionID );
         }
     }
@@ -257,7 +257,7 @@ 
      * @remark      The actual registration will be performed in the <em>_replyToRegisterSettings()</em> method with the <em>admin_menu</em> hook.
      */
     public function addSettingFields( /* $aField1, $aField2=null, $_and_more=null */ ) {
-        foreach( func_get_args() as $aField ) {
+        foreach ( func_get_args() as $aField ) {
             $this->addSettingField( $aField );
         }
     }
@@ -294,8 +294,8 @@ 
     * @param        string      $_and_more      (optional) add more field IDs to the next parameters as many as necessary.
     * @return void
     */
-    public function removeSettingFields( $sFieldID1, $sFieldID2=null, $_and_more ) {
-        foreach( func_get_args() as $_sFieldID ) {
+    public function removeSettingFields( $sFieldID1, $sFieldID2 = null, $_and_more ) {
+        foreach ( func_get_args() as $_sFieldID ) {
             $this->oForm->removeField( $_sFieldID );
         }
     }
@@ -342,7 +342,7 @@ 
             $this->oProp->sOptionKey,
             empty( $_aParams )
                 ? null                  // will return the entire options array
-                : $_aDimensionalKeys,   // dimensional keys
+                : $_aDimensionalKeys, // dimensional keys
             $_mDefault, // default
             $this->getSavedOptions() + $this->oForm->getDefaultFormValues()
         );
@@ -361,21 +361,21 @@ 
      * If the user has not submitted the form, the framework will try to return the default value set in the field definition array.
      * @deprecated  3.3.0
      */
-    public function getFieldValue( $sFieldID, $sSectionID='' ) {
+    public function getFieldValue( $sFieldID, $sSectionID = '' ) {
 
         $this->oUtil->showDeprecationNotice(
-            'The method,' . __METHOD__ . ',', // deprecated item
+            'The method,'.__METHOD__.',', // deprecated item
             'getValue()' // alternative
         );
 
         $_aOptions = $this->oUtil->uniteArrays( $this->oProp->aOptions, $this->oForm->getDefaultFormValues() );
         /* If it's saved, return it */
-        if ( ! $sSectionID ) {
+        if ( !$sSectionID ) {
             if ( array_key_exists( $sFieldID, $_aOptions ) ) {
                 return $_aOptions[ $sFieldID ];
             }
             // loop through section elements
-            foreach( $_aOptions as $aOptions ) {
+            foreach ( $_aOptions as $aOptions ) {
                 if ( array_key_exists( $sFieldID, $aOptions ) ) {
                     return $aOptions[ $sFieldID ];
                 }

development/factory/admin_page/AdminPageFramework_Controller_Page.php

Doc Comments +4 added lines, -37 removed lines

@@ -51,43 +51,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
@@ -277,6 +240,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 ) {

Spacing +14 added lines, -14 removed lines

@@ -93,7 +93,7 @@ 
      * @return      void
      */
     public function addInPageTabs( /* $aTab1, $aTab2=null, $_and_more=null */ ) {
-        foreach( func_get_args() as $asTab ) {
+        foreach ( func_get_args() as $asTab ) {
             $this->addInPageTab( $asTab );
         }
     }
@@ -115,7 +115,7 @@ 
 
         // Target page slug - will be applied when no page slug is specified.
         static $__sTargetPageSlug;
-        if ( ! is_array( $asInPageTab ) ) {
+        if ( !is_array( $asInPageTab ) ) {
             $__sTargetPageSlug = is_string( $asInPageTab )
                 ? $asInPageTab
                 : $__sTargetPageSlug; // set the target page slug
@@ -130,23 +130,23 @@ 
         );
 
         // Set the target page slug for next calls
-        $__sTargetPageSlug  = $aInPageTab[ 'page_slug' ];
+        $__sTargetPageSlug = $aInPageTab[ 'page_slug' ];
 
         // Required keys
-        if ( ! isset( $aInPageTab[ 'page_slug' ], $aInPageTab[ 'tab_slug' ] ) ) {
+        if ( !isset( $aInPageTab[ 'page_slug' ], $aInPageTab[ 'tab_slug' ] ) ) {
             return;
         }
 
         // Count - the number of added in-page tabs.
-        $_aElements         = $this->oUtil->getElement(
+        $_aElements = $this->oUtil->getElement(
             $this->oProp->aInPageTabs,
             $aInPageTab[ 'page_slug' ],
             array()
         );
-        $_iCountElement      = count( $_aElements );
+        $_iCountElement = count( $_aElements );
 
         // Pre-format
-        $aInPageTab         = array(
+        $aInPageTab = array(
             'page_slug' => $this->oUtil->sanitizeSlug( $aInPageTab[ 'page_slug' ] ),
             'tab_slug'  => $this->oUtil->sanitizeSlug( $aInPageTab[ 'tab_slug' ] ),
             'order'     => $this->oUtil->getAOrB(
@@ -174,7 +174,7 @@ 
      * @param       boolean     $bShow If false, the page title will not be displayed.
      * @return      void
      */
-    public function setPageTitleVisibility( $bShow=true, $sPageSlug='' ) {
+    public function setPageTitleVisibility( $bShow = true, $sPageSlug = '' ) {
         $this->_setPageProperty(
             'bShowPageTitle',
             'show_page_title',
@@ -198,7 +198,7 @@ 
      * @remark      Page-heading tabs and in-page tabs are different. The former displays page titles and the latter displays tab titles.
      * @remark      If the second parameter is omitted, it sets the default value.
      */
-    public function setPageHeadingTabsVisibility( $bShow=true, $sPageSlug='' ) {
+    public function setPageHeadingTabsVisibility( $bShow = true, $sPageSlug = '' ) {
         $this->_setPageProperty(
             'bShowPageHeadingTabs',
             'show_page_heading_tabs',
@@ -219,7 +219,7 @@ 
      * @param       string      $sPageSlug  The page to apply the visibility setting. If not set, it applies to all the pages.
      * @remark      If the second parameter is omitted, it sets the default value.
      */
-    public function setInPageTabsVisibility( $bShow=true, $sPageSlug='' ) {
+    public function setInPageTabsVisibility( $bShow = true, $sPageSlug = '' ) {
         $this->_setPageProperty(
             'bShowInPageTabs',
             'show_in_page_tabs',
@@ -242,7 +242,7 @@ 
      * @param       string      $sPageSlug      The page slug that applies the setting.
      * @remark      If the second parameter is omitted, it sets the default value.
      */
-    public function setInPageTabTag( $sTag='h3', $sPageSlug='' ) {
+    public function setInPageTabTag( $sTag = 'h3', $sPageSlug = '' ) {
         $this->_setPageProperty(
             'sInPageTabTag',
             'in_page_tab_tag',
@@ -265,9 +265,9 @@ 
      * @param       string      $sPageSlug  The page slug that applies the setting.
      * @remark      If the second parameter is omitted, it sets the default value.
      */
-    public function setPageHeadingTabTag( $sTag='h2', $sPageSlug='' ) {
+    public function setPageHeadingTabTag( $sTag = 'h2', $sPageSlug = '' ) {
         $this->_setPageProperty(
-            'sPageHeadingTabTag',   // property name
+            'sPageHeadingTabTag', // property name
             'page_heading_tab_tag', // property key
             $sTag, // value
             $sPageSlug  // page slug
@@ -289,7 +289,7 @@ 
 
             $this->oProp->{$sPropertyName} = $mValue;
 
-            foreach( $this->oProp->aPages as &$_aPage ) {
+            foreach ( $this->oProp->aPages as &$_aPage ) {
                 $_aPage[ $sPropertyKey ] = $mValue;
 
             }

development/factory/post_type/_model/AdminPageFramework_PostType_Model__FlushRewriteRules.php

Doc Comments +1 added lines

@@ -25,6 +25,7 @@
      * Sets up hooks and properties.
      *
      * @internal
+     * @param AdminPageFramework_PostType_Model $oFactory
      */
     public function __construct( $oFactory ) {
 

Indentation +1 added lines, -1 removed lines

@@ -92,7 +92,7 @@
 
     }
 
-       /**
+        /**
          * Resets the rewrite rules for custom post types.
          *
          * This must be done after the post type is registered. So the shutdown action hook is used.

Spacing +4 added lines, -4 removed lines

@@ -28,7 +28,7 @@ 
      */
     public function __construct( $oFactory ) {
 
-        if ( ! $this->_shouldProceed( $oFactory ) ) {
+        if ( !$this->_shouldProceed( $oFactory ) ) {
             return;
         }
 
@@ -53,10 +53,10 @@ 
          */
         private function _shouldProceed( $oFactory ) {
 
-            if ( ! $oFactory->oProp->bIsAdmin ) {
+            if ( !$oFactory->oProp->bIsAdmin ) {
                 return false;
             }
-            if ( ! $oFactory->oProp->sCallerPath ) {
+            if ( !$oFactory->oProp->sCallerPath ) {
                 return false;
             }
             return 'plugin' === $oFactory->oProp->sScriptType;
@@ -86,7 +86,7 @@ 
         }
 
         // If the execution flow in the plugin activation hook, schedule flushing rewrite rules.
-        if ( did_action( 'activate_' . plugin_basename( $this->oFactory->oProp->sCallerPath ) ) ) {
+        if ( did_action( 'activate_'.plugin_basename( $this->oFactory->oProp->sCallerPath ) ) ) {
             add_action( 'shutdown', array( $this, '_replyToFlushRewriteRules' ) );
         }
 

development/factory/post_type/_model/AdminPageFramework_PostType_Model__SubMenuOrder.php

Doc Comments +3 added lines

@@ -25,6 +25,7 @@ 
      * Sets up hooks and properties.
      *
      * @internal
+     * @param AdminPageFramework_PostType_Model $oFactory
      */
     public function __construct( $oFactory ) {
 
@@ -81,6 +82,7 @@ 
 
         /**
          * @since       3.7.4
+         * @param string $sSubMenuSlug
          */
         private function _setSubMenuSlugForSorting( $sSubMenuSlug ) {
 
@@ -93,6 +95,7 @@ 
 
         /**
          * @since       3.7.4
+         * @param string $sSubMenuSlug
          */
         private function _setSubMenuItemIndex( $sSubMenuSlug ) {
 

Spacing +12 added lines, -12 removed lines

@@ -30,7 +30,7 @@ 
 
         $this->oFactory = $oFactory;
 
-        if ( ! $oFactory->oProp->bIsAdmin ) {
+        if ( !$oFactory->oProp->bIsAdmin ) {
             return;
         }
 
@@ -46,7 +46,7 @@ 
 
         add_action(
             'admin_menu',
-            array( $this, 'sortAdminSubMenu' ),  // defined in the framework utility class.
+            array( $this, 'sortAdminSubMenu' ), // defined in the framework utility class.
             9999
         );
 
@@ -61,15 +61,15 @@ 
 
         // Check the post type `show_ui` and other related UI arguments.
         $_bsShowInMeenu = $this->getShowInMenuPostTypeArgument( $this->oFactory->oProp->aPostTypeArgs );
-        if ( ! $_bsShowInMeenu ) {
+        if ( !$_bsShowInMeenu ) {
             return;
         }
 
         // If the user sets a menu slug to the 'show_in_menu' argument, use that.
         // It is used to set a custom post type sub-menu belong to another menu.
-        $_sSubMenuSlug  = is_string( $_bsShowInMeenu )
+        $_sSubMenuSlug = is_string( $_bsShowInMeenu )
             ? $_bsShowInMeenu
-            : 'edit.php?post_type=' . $this->oFactory->oProp->sPostType;
+            : 'edit.php?post_type='.$this->oFactory->oProp->sPostType;
 
         // Set the index to the framework specific global array for sorting.
         $this->_setSubMenuSlugForSorting( $_sSubMenuSlug );
@@ -130,11 +130,11 @@ 
 
                 // @remark      This is the partial link url set in the third element ( index of 2 ) in the third dimension of submenu global array element.
                 // This is not the submenu slug.
-                $_sLinkSlugManage = 'edit.php?post_type=' . $this->oFactory->oProp->sPostType;
+                $_sLinkSlugManage = 'edit.php?post_type='.$this->oFactory->oProp->sPostType;
 
                 $_aLinkSlugs = array(
                     $_sLinkSlugManage => $_nSubMenuOrderManage,
-                    'post-new.php?post_type=' . $this->oFactory->oProp->sPostType => $_nSubMenuOrderAddNew,
+                    'post-new.php?post_type='.$this->oFactory->oProp->sPostType => $_nSubMenuOrderAddNew,
                 );
 
                 // If the user does not set a custom value, unset it
@@ -143,8 +143,8 @@ 
                 }
 
                 // If the user does not want to show the Add New sub menu, no need to change the order.
-                if ( ! $_bShowAddNew || 10 == $_nSubMenuOrderAddNew ) {
-                    unset( $_aLinkSlugs[ 'post-new.php?post_type=' . $this->oFactory->oProp->sPostType ] );
+                if ( !$_bShowAddNew || 10 == $_nSubMenuOrderAddNew ) {
+                    unset( $_aLinkSlugs[ 'post-new.php?post_type='.$this->oFactory->oProp->sPostType ] );
                 }
 
                 return $_aLinkSlugs;
@@ -164,9 +164,9 @@ 
          */
         private function _setSubMenuIndexByLinksSlugs( $sSubMenuSlug, array $aLinkSlugs ) {
 
-            foreach( $this->getElementAsArray( $GLOBALS, array( 'submenu', $sSubMenuSlug ) ) as $_nIndex => $_aSubMenuItem ) {
+            foreach ( $this->getElementAsArray( $GLOBALS, array( 'submenu', $sSubMenuSlug ) ) as $_nIndex => $_aSubMenuItem ) {
 
-                foreach( $aLinkSlugs as $_sLinkSlug => $_nOrder ) {
+                foreach ( $aLinkSlugs as $_sLinkSlug => $_nOrder ) {
 
                     $_bIsSet = $this->_setSubMenuIndexByLinksSlug( $sSubMenuSlug, $_nIndex, $_aSubMenuItem, $_sLinkSlug, $_nOrder );
 
@@ -192,7 +192,7 @@ 
             private function _setSubMenuIndexByLinksSlug( $sSubMenuSlug, $nIndex, $aSubMenuItem, $sLinkSlug, $nOrder ) {
 
                 // The third item is the link slug.
-                if ( ! isset( $aSubMenuItem[ 2 ] ) ) {
+                if ( !isset( $aSubMenuItem[ 2 ] ) ) {
                     return false;
                 }
                 if ( $aSubMenuItem[ 2 ] !== $sLinkSlug ) {