michaeluno / admin-page-framework

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();

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 ) {
        

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`.

Braces +4 added lines, -3 removed lines

@@ -137,7 +137,7 @@ 
 
         // Save the data.
         $_bUpdated = false;
-        if ( ! $this->oFactory->oProp->_bDisableSavingOptions ) {  
+        if ( ! $this->oFactory->oProp->_bDisableSavingOptions ) {
             $_bUpdated = $this->oFactory->oProp->updateOption( $_aInputs );
         }
 
@@ -180,14 +180,15 @@ 
                     $_POST[ 'admin_page_framework_start' ], // indicates the framework form is started
                     $_POST[ '_wp_http_referer' ]
                 ) 
-            ) {     
+            ) {
                 return false;
             }
             
             // Referrer
             $_sRequestURI   = remove_query_arg( array( 'settings-updated', 'confirmation', 'field_errors' ), wp_unslash( $_SERVER[ 'REQUEST_URI' ] ) );
             $_sRefererURI   = remove_query_arg( array( 'settings-updated', 'confirmation', 'field_errors' ), $_POST[ '_wp_http_referer' ] );
-            if ( $_sRequestURI != $_sRefererURI ) { // see the function definition of wp_referer_field() in functions.php.
+            if ( $_sRequestURI != $_sRefererURI ) {
+// 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.
      */

Braces +2 added lines, -2 removed lines

@@ -46,7 +46,7 @@ 
      * @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 ) {
             
@@ -84,7 +84,7 @@ 
      */
     protected function _setSettingNoticeAfterValidation( $bIsInputEmtpy ) {
      
-        if ( $this->oFactory->hasSettingNotice() ) {     
+        if ( $this->oFactory->hasSettingNotice() ) {
             return;
         }
         $this->oFactory->setSettingNotice(  

development/factory/admin_page/_view/AdminPageFramework_View__PageRenderer.php

Doc Comments +1 added lines

@@ -28,6 +28,7 @@
     /**
      * Sets up properties.
      * @since       3.6.3
+     * @param AdminPageFramework_View_Page $oFactory
      */
     public function __construct( $oFactory, $sPageSlug, $sTabSlug ) {
        

development/factory/admin_page/_view/AdminPageFramework_View__PageRenderer__PageHeadingTabs.php

Doc Comments +2 added lines

@@ -60,6 +60,7 @@ 
          * @since       3.3.1       Moved from `AdminPageFramework_Page`.
          * @since       3.5.3       Deprecated the `$aOutput` parameter.
          * @since       3.6.3       Moved from `AdminPageFramework_Page_View`. Changed the name from `_getPageHeadingTabs()`.
+         * @param string $sTag
          * @return      string      the output of page heading tabs.
          */
         private function _getOutput( $aPage, $sTag ) {
@@ -100,6 +101,7 @@ 
              * @internal
              * @since       3.5.3
              * @since       3.6.3       Moved from `AdminPageFramework_Page_View`.
+             * @param string $sTag
              * @return      string      the HTML page heading tab navigation bar output.
              */
             private function _getPageHeadingtabNavigationBar( array $aPages, $sTag, $sCurrentPageSlug ) {

development/factory/admin_page/_view/AdminPageFramework_View__PageRenderer__ScreenIcon.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
     }
         /**
          * @since       3.6.3
-         * @return      boolean
+         * @return      boolean|null
          */
         private function _isScreenIconVisible() {
             

development/factory/widget/AdminPageFramework_Widget_Factory.php

Doc Comments +1 added lines

@@ -23,6 +23,7 @@
      * Sets up internal properties.
      * 
      * @since       3.2.0
+     * @param AdminPageFramework_Widget_Model $oCaller
      * @return      void
      */
 	public function __construct( $oCaller, $sWidgetTitle, array $aArguments=array() ) {

development/factory/admin_page/AdminPageFramework.php

Braces +1 added lines, -1 removed lines

@@ -56,7 +56,7 @@
      * @param       string                  $sCapability    (optional) sets the overall access level to the admin pages created by the framework. The used capabilities are listed <a href="http://codex.wordpress.org/Roles_and_Capabilities">here</a>. The capability can be set per page, tab, setting section, setting field. Default: `manage_options`
      * @param       string                  $sTextDomain    (optional) the <a href="http://codex.wordpress.org/I18n_for_WordPress_Developers#Text_Domains" target="_blank">text domain</a> used for the framework's system messages. Default: admin-page-framework.
      */
-    public function __construct( $isOptionKey=null, $sCallerPath=null, $sCapability='manage_options', $sTextDomain='admin-page-framework' ){
+    public function __construct( $isOptionKey=null, $sCallerPath=null, $sCapability='manage_options', $sTextDomain='admin-page-framework' ) {
                         
         if ( ! $this->_isInstantiatable() ) {
             return;

Doc Comments +2 added lines, -1 removed lines

@@ -45,7 +45,7 @@ 
      * @since       2.0.0
      * @see         http://codex.wordpress.org/Roles_and_Capabilities
      * @see         http://codex.wordpress.org/I18n_for_WordPress_Developers#Text_Domains
-     * @param       array|integer|string    $aisOptionKey    (optional) specifies the option key name to store in the options table. If this is not set, the instantiated class name will be used as default.
+     * @param       array|integer|string    $isOptionKey    (optional) specifies the option key name to store in the options table. If this is not set, the instantiated class name will be used as default.
      * [3.5.9+] If an integer is given, a transient will be used. If an array of option key arguments is given, the argument values will be set to the framework properties.
      * - type - either `options_table` or `transient`.
      * - key - the option key or the transient key
@@ -84,6 +84,7 @@ 
         /**
          * Returns the script caller path.
          * @remark      It is important to find the caller script path here when separating the library into multiple files.
+         * @param string|null $sCallerPath
          * @return      null|string
          * @since       3.8.2
          */