michaeluno / admin-page-framework

development/factory/admin_page/_model/AdminPageFramework_FormEmail.php

Doc Comments +1 added lines

@@ -202,6 +202,7 @@
          * 
          * @since       3.3.0
          * @since       3.4.2       Moved from the validation class.
+         * @param string $sKey
          */
         private function _getEmailArgument( $aInput, array $aEmailOptions, $sKey, $sSectionID ) {
             

Indentation +1 added lines, -1 removed lines

@@ -277,7 +277,7 @@
         );        
     }    
     
-       /**
+        /**
          * Extracts meta box form fields options array from the given options array of an admin page.
          * 
          * @since       3.5.6

Spacing +4 added lines, -4 removed lines

@@ -86,7 +86,7 @@ 
         }
 
         // Send mail.
-        $_bSent         = wp_mail(
+        $_bSent = wp_mail(
             $this->_getEmailArgument( $aInput, $aEmailOptions, 'to', $sSubmitSectionID ),
             $this->_getEmailArgument( $aInput, $aEmailOptions, 'subject', $sSubmitSectionID ),
             $_bIsHTML
@@ -101,7 +101,7 @@ 
         remove_filter( 'wp_mail_from_name', array( $this, '_replyToSetEmailSenderAddress' ) );
         
         // Clean up.
-        foreach( $this->_aPathsToDelete as $_sPath ) {
+        foreach ( $this->_aPathsToDelete as $_sPath ) {
             unlink( $_sPath );
         }
         
@@ -122,7 +122,7 @@ 
             }
             
             $_aAttachments = $this->getAsArray( $asAttachments );
-            foreach( $_aAttachments as $_iIndex => $_sPathORURL ) {
+            foreach ( $_aAttachments as $_iIndex => $_sPathORURL ) {
                 
                 // If it is a file path, fine.
                 if ( is_file( $_sPathORURL ) ) {
@@ -213,7 +213,7 @@ 
             }
             
             // If the key element is empty, search the corresponding item in the same section. 
-            if ( ! $aEmailOptions[ $sKey ] ) {
+            if ( !$aEmailOptions[ $sKey ] ) {
                 return $this->getArrayValueByArrayKeys( $aInput, array( $sSectionID, $sKey ) );
             }
             

development/factory/admin_page/_model/AdminPageFramework_ImportOptions.php

Doc Comments +5 added lines

@@ -89,6 +89,11 @@
         return $vData;
         
     }
+
+    /**
+     * @param string $vData
+     * @param string $sFormatType
+     */
     public function formatImportData( &$vData, $sFormatType=null ) {
         
         $sFormatType = isset( $sFormatType ) ? $sFormatType : $this->getFormatType();

Spacing +3 added lines, -3 removed lines

@@ -57,11 +57,11 @@ 
         
     }
     
-    private function getElementInFilesArray( array $aFilesImport, $sInputID, $sElementKey='error' ) {
+    private function getElementInFilesArray( array $aFilesImport, $sInputID, $sElementKey = 'error' ) {
 
         $sElementKey = strtolower( $sElementKey );
         return $this->getElement( 
-            $aFilesImport,  // subject array
+            $aFilesImport, // subject array
             array( $sElementKey, $sInputID ), // dimensional keys
             null    // default
         );
@@ -89,7 +89,7 @@ 
         return $vData;
         
     }
-    public function formatImportData( &$vData, $sFormatType=null ) {
+    public function formatImportData( &$vData, $sFormatType = null ) {
         
         $sFormatType = isset( $sFormatType ) ? $sFormatType : $this->getFormatType();
         switch ( strtolower( $sFormatType ) ) {

development/factory/admin_page/_model/delegate/AdminPageFramework_Model__FormEmailHandler.php

Doc Comments +1 added lines

@@ -25,6 +25,7 @@
     /**
      * Sets up properties.
      * @since       3.6.3
+     * @param AdminPageFramework_Model_Form $oFactory
      */
     public function __construct( $oFactory ) {
        

Spacing +4 added lines, -4 removed lines

@@ -29,10 +29,10 @@ 
      */
     public function __construct( $oFactory ) {
        
-        $this->oFactory         = $oFactory;
+        $this->oFactory = $oFactory;
 
         // Form emails.
-        if ( ! isset( $_GET[ 'apf_action' ], $_GET[ 'transient' ] ) ) {
+        if ( !isset( $_GET[ 'apf_action' ], $_GET[ 'transient' ] ) ) {
             return;
         }
         if ( 'email' !== $_GET[ 'apf_action' ] ) {
@@ -74,12 +74,12 @@ 
             self::$_bDoneEmail = true;
 
             $_sTransient = $this->getElement( $_GET, 'transient', '' );
-            if ( ! $_sTransient ) {
+            if ( !$_sTransient ) {
                 return;
             }
             $_aFormEmail = $this->getTransient( $_sTransient );
             $this->deleteTransient( $_sTransient );
-            if ( ! is_array( $_aFormEmail ) ) {
+            if ( !is_array( $_aFormEmail ) ) {
                 return;
             }
 

development/factory/admin_page/_model/delegate/AdminPageFramework_Model__FormSubmission.php

Doc Comments +6 added lines

@@ -26,6 +26,7 @@ 
     /**
      * Sets up hooks and properties.
      * @since       3.6.3
+     * @param AdminPageFramework_Model_Form $oFactory
      */
     public function __construct( $oFactory, $aSavedData, $aArguments, $aSectionsets, $aFieldsets ) {
        
@@ -250,6 +251,9 @@ 
          * Do the 'submit_...' actions.
          * 
          * @internal
+         * @param null|string $_sSubmitSectionID
+         * @param null|string $_sPressedFieldID
+         * @param null|string $_sPressedInputID
          * @return      void
          * @since       3.5.3
          * @since       3.6.3       Moved from `AdminPageFramework_Validation`.
@@ -296,6 +300,8 @@ 
          * Do the 'submit_after_...' actions.
          * 
          * @internal
+         * @param null|string $_sSubmitSectionID
+         * @param null|string $_sPressedFieldID
          * @return      void
          * @since       3.5.3
          * @since       3.6.3       Moved from `AdminPageFramework_Validation`.

Spacing +13 added lines, -13 removed lines

@@ -29,7 +29,7 @@ 
      */
     public function __construct( $oFactory, $aSavedData, $aArguments, $aSectionsets, $aFieldsets ) {
        
-        $this->oFactory         = $oFactory;
+        $this->oFactory = $oFactory;
                 
         // add_action
         // @deprecated      3.7.0
@@ -72,7 +72,7 @@ 
      */
     public function _handleFormData() {
         
-        if ( ! $this->_shouldProceed() ) {
+        if ( !$this->_shouldProceed() ) {
             return;
         }
 
@@ -127,7 +127,7 @@ 
         new AdminPageFramework_Model__FormSubmission__Validator( $this->oFactory );
         
         // [3.6.3+] Apply filters. All the sub-routines of handling form submit data use this filter hook.
-        $_aInputs    = $this->addAndApplyFilters(
+        $_aInputs = $this->addAndApplyFilters(
             $this->oFactory,
             "validation_pre_{$this->oFactory->oProp->sClassName}",
             $_aInputs,
@@ -138,7 +138,7 @@ 
 
         // Save the data.
         $_bUpdated = false;
-        if ( ! $this->oFactory->oProp->_bDisableSavingOptions ) {
+        if ( !$this->oFactory->oProp->_bDisableSavingOptions ) {
             $_bUpdated = $this->oFactory->oProp->updateOption( $_aInputs );
         }
 
@@ -177,7 +177,7 @@ 
         private function _shouldProceed() {
             
             if (
-                ! isset(
+                !isset(
                     $_POST[ 'admin_page_framework_start' ], // indicates the framework form is started
                     $_POST[ '_wp_http_referer' ]
                 )
@@ -194,7 +194,7 @@ 
             
             // Check if all the form fields are sent. 
             if (
-                ! isset(
+                !isset(
                     // these keys are supposed to be embedded at the end of the form.
                     // if the server truncates the form input values for `max_input_vars`, these will be lost in PHP 5.3.9 or above.
                     $_POST[ '_is_admin_page_framework' ], // holds the form nonce
@@ -215,7 +215,7 @@ 
                 return false;
             }
                         
-            $_sNonceTransientKey = 'form_' . md5( $this->oFactory->oProp->sClassName . get_current_user_id() );
+            $_sNonceTransientKey = 'form_'.md5( $this->oFactory->oProp->sClassName.get_current_user_id() );
             if ( $_POST[ '_is_admin_page_framework' ] !== $this->getTransient( $_sNonceTransientKey ) ) {
                 $this->oFactory->setAdminNotice( $this->oFactory->oMsg->get( 'nonce_verification_failed' ) );
 
@@ -234,7 +234,7 @@ 
          */
         private function _getUserInputsFromPOST() {
 
-            $_aInputs     = $this->getElementAsArray(
+            $_aInputs = $this->getElementAsArray(
                 $_POST,
                 $this->oFactory->oProp->sOptionKey,
                 array()
@@ -262,7 +262,7 @@ 
             // Warnings for deprecated hooks.
             if ( has_action( "submit_{$this->oFactory->oProp->sClassName}_{$_sPressedInputID}" ) ) {
                 trigger_error(
-                    'Admin Page Framework: ' . ' : '
+                    'Admin Page Framework: '.' : '
                         . sprintf(
                             __( 'The hook <code>%1$s</code>is deprecated. Use <code>%2$s</code> instead.', $this->oFactory->oProp->sTextDomain ),
                             "submit_{instantiated class name}_{pressed input id}",
@@ -275,7 +275,7 @@ 
                 $this->oFactory,
                 array(
                     // @todo deprecate the hook with the input ID
-                    "submit_{$this->oFactory->oProp->sClassName}_{$_sPressedInputID}",  // will be deprecated in near future release
+                    "submit_{$this->oFactory->oProp->sClassName}_{$_sPressedInputID}", // will be deprecated in near future release
                     $_sSubmitSectionID
                         ? "submit_{$this->oFactory->oProp->sClassName}_{$_sSubmitSectionID}_{$_sPressedFieldID}"
                         : "submit_{$this->oFactory->oProp->sClassName}_{$_sPressedFieldID}",
@@ -358,9 +358,9 @@ 
             
             // Drop the 'field_errors' key.
             $_aRemoveQueries = array();
-            if ( ! isset( $aStatus[ 'field_errors' ] ) || ! $aStatus[ 'field_errors' ] ) {
+            if ( !isset( $aStatus[ 'field_errors' ] ) || !$aStatus[ 'field_errors' ] ) {
                 unset( $aStatus[ 'field_errors' ] );
-                $_aRemoveQueries[] = 'field_errors';
+                $_aRemoveQueries[ ] = 'field_errors';
             }
          
             return $this->addAndApplyFilters(    // 3.4.4+
@@ -385,7 +385,7 @@ 
          */
         private function _removePageElements( $aOptions, $sPageSlug, $sTabSlug ) {
             
-            if ( ! $sPageSlug && ! $sTabSlug ) {
+            if ( !$sPageSlug && !$sTabSlug ) {
                 return $aOptions;
             }
             

Braces +2 added lines, -1 removed lines

@@ -188,7 +188,8 @@
             // Referrer
             $_sRequestURI   = remove_query_arg( array( 'settings-updated', 'confirmation', 'field_errors' ), wp_unslash( $_SERVER[ 'REQUEST_URI' ] ) );
             $_sReffererURI  = remove_query_arg( array( 'settings-updated', 'confirmation', 'field_errors' ), $_POST[ '_wp_http_referer' ] );
-            if ( $_sRequestURI != $_sReffererURI ) { // see the function definition of wp_referer_field() in functions.php.
+            if ( $_sRequestURI != $_sReffererURI ) {
+// see the function definition of wp_referer_field() in functions.php.
                 return false;
             }
             

development/factory/admin_page/_model/delegate/AdminPageFramework_Model__FormSubmission_Base.php

Doc Comments +1 added lines

@@ -79,6 +79,7 @@
      * @since       3.5.3
      * @since       3.6.3       Moved from `AdminPageFramework_Form_Model_Validation_Option`.
      * @internal
+     * @param boolean $bIsInputEmtpy
      * @return      void
      * @remark      Accessed from some of the parent/child classes.
      */

Spacing +3 added lines, -3 removed lines

@@ -47,12 +47,12 @@
      * @return      null|string     Returns `null` if no value is found and the associated link url if found. 
      * Otherwise, the found value.
      */
-    protected function _getPressedSubmitButtonData( array $aPostElements, $sTargetKey='field_id' ) {
+    protected function _getPressedSubmitButtonData( array $aPostElements, $sTargetKey = 'field_id' ) {
 
-        foreach( $aPostElements as $_sInputID => $_aSubElements ) {
+        foreach ( $aPostElements as $_sInputID => $_aSubElements ) {
             
             // The 'name' key must be set.
-            if ( ! isset( $_aSubElements[ 'name' ] ) ) {
+            if ( !isset( $_aSubElements[ 'name' ] ) ) {
                 continue;
             }
             $_aNameKeys = explode( '|', $_aSubElements[ 'name' ] );

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

Doc Comments +2 added lines

@@ -92,6 +92,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 ) {
@@ -132,6 +133,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 ) {        

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 +4 added lines, -4 removed lines

@@ -33,7 +33,7 @@ 
      */
     public function _replyToCallback( $aInputs, $aRawInputs, array $aSubmits, $aSubmitInformation, $oFactory ) {
         
-        if ( ! $this->_shouldProceed() ) {
+        if ( !$this->_shouldProceed() ) {
             return;
         }
         $this->_exportOptions(
@@ -66,11 +66,11 @@ 
          */
         protected function _exportOptions( $mData, $sPageSlug, $sTabSlug ) {
 
-            $_oExport           = new AdminPageFramework_ExportOptions(
+            $_oExport = new AdminPageFramework_ExportOptions(
                 $_POST[ '__export' ],
                 $this->oFactory->oProp->sClassName
             );
-            $_aArguments        = array(
+            $_aArguments = array(
                 'class_name'        => $this->oFactory->oProp->sClassName,
                 'page_slug'         => $sPageSlug,
                 'tab_slug'          => $sTabSlug,
@@ -142,7 +142,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

@@ -143,6 +143,7 @@ 
                 /**
                  * Sets update admin notice.
                  * @since       3.5.3
+                 * @param boolean $bEmpty
                  * @return      void
                  */
                 private function _setImportAdminNotice( $bEmpty ) {
@@ -204,6 +205,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 ) {
@@ -232,6 +235,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 +13 added lines, -13 removed lines

@@ -32,7 +32,7 @@ 
      * @callback    action      try_validation_after_{class name}
      */
     public function _replyToCallback( $aInputs, $aRawInputs, array $aSubmits, $aSubmitInformation, $oFactory ) {
-        if ( ! $this->_shouldProceed() ) {
+        if ( !$this->_shouldProceed() ) {
             return;
         }
         $this->_doImportOptions(
@@ -104,10 +104,10 @@ 
                 // 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.
@@ -174,9 +174,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
                     );
@@ -265,18 +265,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

@@ -66,6 +66,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

@@ -35,7 +35,7 @@ 
             $aSubmits,
             'redirect_url'
         );
-        if ( ! $_sRedirectURL ) {
+        if ( !$_sRedirectURL ) {
             return;
         }
         
@@ -71,9 +71,9 @@ 
             if ( empty( $sURL ) ) {
                 return;
             }
-            $_sTransient = 'apf_rurl' . md5( trim( "redirect_{$this->oFactory->oProp->sClassName}_{$sPageSlug}" ) );
+            $_sTransient = 'apf_rurl'.md5( trim( "redirect_{$this->oFactory->oProp->sClassName}_{$sPageSlug}" ) );
 
-            return $this->setTransient( $_sTransient, $sURL , 60*2 );
+            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

@@ -60,6 +60,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

@@ -35,7 +35,7 @@ 
      */
     public function _replyToCallback( $aInputs, $aRawInputs, array $aSubmits, $aSubmitInformation, $oFactory ) {
             
-        if ( ! $this->_shouldProceed( $oFactory, $aSubmits ) ) {
+        if ( !$this->_shouldProceed( $oFactory, $aSubmits ) ) {
             return;
         }
             
@@ -45,7 +45,7 @@ 
             'reset_key'
         );
         $_sKeyToReset = trim( $_sKeyToReset );
-        if ( ! $_sKeyToReset ) {
+        if ( !$_sKeyToReset ) {
             return;
         }
         $_oException = new Exception( 'aReturn' );
@@ -62,7 +62,7 @@ 
          * @return      boolean
          */
         protected function _shouldProceed( $oFactory, $aSubmits ) {
-            return ! $oFactory->hasFieldError();
+            return !$oFactory->hasFieldError();
         }
         
         /**
@@ -80,12 +80,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();