michaeluno / admin-page-framework

development/utility/pointer_tool_tip/AdminPageFramework_PointerToolTip.php

Doc Comments +1 added lines, -1 removed lines

@@ -66,7 +66,7 @@
      * 
      * @since       DEVVER
      * @see         https://codex.wordpress.org/Plugin_API/Admin_Screen_Reference
-     * @param       array|strin     $asScreenIDs        Screen IDs or page slug.
+     * @param       string[]     $asScreenIDs        Screen IDs or page slug.
      * @param       string          $sPointerID         A unique pointer ID.
      * @Param       array           $aPointerData       The pointer data.
      */

Indentation +1 added lines, -1 removed lines

@@ -173,7 +173,7 @@
                     get_current_user_id(), 
                     'dismissed_wp_pointers', 
                     true 
-               )
+                )
             );
             $_aValidPointers = array(
                 'pointers'  => array(),

Spacing +11 added lines, -11 removed lines

@@ -91,18 +91,18 @@ 
          */
         private function _setHooks( $aScreenIDs ) {
             
-            foreach( $aScreenIDs as $_sScreenID ) {
-                if ( ! $_sScreenID ) {
+            foreach ( $aScreenIDs as $_sScreenID ) {
+                if ( !$_sScreenID ) {
                     continue;
                 }
                 add_filter(
-                    get_class( $this ) . '-' . $_sScreenID,
+                    get_class( $this ).'-'.$_sScreenID,
                     array( $this, '_replyToSetPointer' )
                 );
                                 
             }
             
-            if ( ! $this->_hasBeenCalled() ) {
+            if ( !$this->_hasBeenCalled() ) {
                 return;
             }
             
@@ -147,7 +147,7 @@ 
     
         $_aPointers = $this->_getValidPointers( $this->_getPointers() );
              
-        if ( empty( $_aPointers ) || ! is_array( $_aPointers ) ) {
+        if ( empty( $_aPointers ) || !is_array( $_aPointers ) ) {
             return;
         }
         
@@ -166,11 +166,11 @@ 
             $_oScreen   = get_current_screen();
             $_sScreenID = $_oScreen->id;
             if ( in_array( $_sScreenID, $this->aScreenIDs ) ) {
-                return apply_filters( get_class( $this ) . '-' . $_sScreenID, array() );
+                return apply_filters( get_class( $this ).'-'.$_sScreenID, array() );
             }
             
             if ( isset( $_GET[ 'page' ] ) ) {
-                return apply_filters( get_class( $this ) . '-' . $_GET[ 'page' ], array() );
+                return apply_filters( get_class( $this ).'-'.$_GET[ 'page' ], array() );
             }
 
             return array();
@@ -184,7 +184,7 @@ 
         private function _getValidPointers( $_aPointers ) {
         
             // Get dismissed pointers
-            $_aDismissed      = explode(
+            $_aDismissed = explode(
                 ',',
                 ( string ) get_user_meta(
                     get_current_user_id(),
@@ -212,7 +212,7 @@ 
                 $_aPointer[ 'pointer_id' ] = $_iPointerID;
                 
                 // Add the pointer to $_aValidPointers array
-                $_aValidPointers[] =  $_aPointer;
+                $_aValidPointers[ ] = $_aPointer;
                 
             }
 
@@ -284,9 +284,9 @@ 
          * @since       3.7.0
          * @return      string     
          */
-        public function _getInlineScript( $aPointers=array() ) {
+        public function _getInlineScript( $aPointers = array() ) {
 
-            $_aJSArray      = json_encode( $aPointers );
+            $_aJSArray = json_encode( $aPointers );
 
             /**
              * Checks checkboxes in siblings.

development/utility/requirement/AdminPageFramework_Requirement.php

Doc Comments +3 added lines

@@ -134,6 +134,7 @@ 
          * Returns a php warning if present.
          * @since       3.5.3
          * @internal
+         * @param string $sType
          * @return      string      The warning.
          */
         private function _getWarningByType( $sType ) {
@@ -226,6 +227,7 @@ 
              * if it returns non true (false), it stores the subject warning and returns the array holding the warnings.
              * 
              * @since       3.4.6
+             * @param string $sFuncName
              * @return      array           The warning array.
              */
             private function _getWarningsByFunctionName( $sFuncName, $aSubjects ) {
@@ -285,6 +287,7 @@ 
     /**
      * Deactivates the plugin.
      * @since       3.4.6
+     * @param string $sPluginFilePath
      */
     public function deactivatePlugin( $sPluginFilePath, $sMessage='', $bIsOnActivation=false ) {
         

Indentation +1 added lines, -1 removed lines

@@ -278,7 +278,7 @@
                     ?  "<strong>" . $this->_sScriptName . "</strong>:&nbsp;" 
                     : '';            
                 return $_sScripTitle
-                   . implode( '<br />', $_aWarnings );
+                    . implode( '<br />', $_aWarnings );
                 
             }
         

Spacing +24 added lines, -24 removed lines

@@ -76,12 +76,12 @@ 
      * 
      * @since       3.4.6
      */
-    public function __construct( array $aRequirements=array(), $sScriptName='' ) {
+    public function __construct( array $aRequirements = array(), $sScriptName = '' ) {
         
         // Avoid undefined index warnings.
         $aRequirements          = $aRequirements + $this->_aDefaultRequirements;
         $aRequirements          = array_filter( $aRequirements, 'is_array' );
-        foreach( array( 'php', 'mysql', 'wordpress' ) as $_iIndex => $_sName ) {
+        foreach ( array( 'php', 'mysql', 'wordpress' ) as $_iIndex => $_sName ) {
             if ( isset( $aRequirements[ $_sName ] ) ) {
                 $aRequirements[ $_sName ] = $aRequirements[ $_sName ] + $this->_aDefaultRequirements[ $_sName ];
             }
@@ -105,9 +105,9 @@ 
         $_aWarnings = array();
         
         // PHP, WordPress, MySQL
-        $_aWarnings[] = $this->_getWarningByType( 'php' );
-        $_aWarnings[] = $this->_getWarningByType( 'wordpress' );
-        $_aWarnings[] = $this->_getWarningByType( 'mysql' );
+        $_aWarnings[ ] = $this->_getWarningByType( 'php' );
+        $_aWarnings[ ] = $this->_getWarningByType( 'wordpress' );
+        $_aWarnings[ ] = $this->_getWarningByType( 'mysql' );
         
         // Ensure necessary array elements.
         $this->_aRequirements = $this->_aRequirements + array(
@@ -120,10 +120,10 @@ 
         // Check the rest.
         $_aWarnings = array_merge(
             $_aWarnings,
-            $this->_checkFunctions( $this->_aRequirements['functions'] ),
-            $this->_checkClasses( $this->_aRequirements['classes'] ),
-            $this->_checkConstants( $this->_aRequirements['constants'] ),
-            $this->_checkFiles( $this->_aRequirements['files'] )
+            $this->_checkFunctions( $this->_aRequirements[ 'functions' ] ),
+            $this->_checkClasses( $this->_aRequirements[ 'classes' ] ),
+            $this->_checkConstants( $this->_aRequirements[ 'constants' ] ),
+            $this->_checkFiles( $this->_aRequirements[ 'files' ] )
         );
         
         $this->aWarnings = array_filter( $_aWarnings ); // drop empty elements.
@@ -137,7 +137,7 @@ 
          * @return      string      The warning.
          */
         private function _getWarningByType( $sType ) {
-            if ( ! isset( $this->_aRequirements[ $sType ][ 'version' ] ) ) {
+            if ( !isset( $this->_aRequirements[ $sType ][ 'version' ] ) ) {
                 return '';
             }
             if ( $this->_checkPHPVersion( $this->_aRequirements[ $sType ][ 'version' ] ) ) {
@@ -165,7 +165,7 @@ 
          * @since       3.4.6
          */
         private function _checkWordPressVersion( $sWordPressVersion ) {
-            return version_compare( $GLOBALS['wp_version'], $sWordPressVersion, ">=" );
+            return version_compare( $GLOBALS[ 'wp_version' ], $sWordPressVersion, ">=" );
         }
         
         /**
@@ -231,9 +231,9 @@ 
              */
             private function _getWarningsByFunctionName( $sFuncName, $aSubjects ) {
                 $_aWarnings = array();
-                foreach( $aSubjects as $_sSubject => $_sWarning ) {
-                    if ( ! call_user_func_array( $sFuncName, array( $_sSubject ) ) ) {
-                        $_aWarnings[] = sprintf( $_sWarning, $_sSubject );
+                foreach ( $aSubjects as $_sSubject => $_sWarning ) {
+                    if ( !call_user_func_array( $sFuncName, array( $_sSubject ) ) ) {
+                        $_aWarnings[ ] = sprintf( $_sWarning, $_sSubject );
                     }
                 }
 
@@ -254,7 +254,7 @@ 
          */
         public function _replyToPrintAdminNotices() {
             
-            $_aWarnings     = array_unique( $this->aWarnings );
+            $_aWarnings = array_unique( $this->aWarnings );
             if ( empty( $_aWarnings ) ) {
                 return;
             }
@@ -272,12 +272,12 @@ 
              */
             private function _getWarnings() {
 
-                $_aWarnings     = array_unique( $this->aWarnings );
+                $_aWarnings = array_unique( $this->aWarnings );
                 if ( empty( $_aWarnings ) ) {
                     return '';
                 }
-                $_sScripTitle   = $this->_sScriptName
-                    ?  "<strong>" . $this->_sScriptName . "</strong>:&nbsp;"
+                $_sScripTitle = $this->_sScriptName
+                    ? "<strong>".$this->_sScriptName."</strong>:&nbsp;"
                     : '';
 
                 return $_sScripTitle
@@ -289,12 +289,12 @@ 
      * Deactivates the plugin.
      * @since       3.4.6
      */
-    public function deactivatePlugin( $sPluginFilePath, $sMessage='', $bIsOnActivation=false ) {
+    public function deactivatePlugin( $sPluginFilePath, $sMessage = '', $bIsOnActivation = false ) {
         
         add_action( 'admin_notices', array( $this, '_replyToPrintAdminNotices' ) );
-        $this->aWarnings[] = '<strong>' . $sMessage . '</strong>';
-        if ( ! function_exists( 'deactivate_plugins' ) ) {
-            if ( ! @include( ABSPATH . '/wp-admin/includes/plugin.php' ) ) {
+        $this->aWarnings[ ] = '<strong>'.$sMessage.'</strong>';
+        if ( !function_exists( 'deactivate_plugins' ) ) {
+            if ( !@include( ABSPATH.'/wp-admin/includes/plugin.php' ) ) {
                 return;
             }
         }
@@ -304,8 +304,8 @@ 
         // Before that, we can display messages to the user.
         if ( $bIsOnActivation ) {
             
-            $_sPluginListingPage = add_query_arg( array(), $GLOBALS['pagenow'] );
-            wp_die( $this->_getWarnings() . "<p><a href='$_sPluginListingPage'>Go back</a>.</p>" );
+            $_sPluginListingPage = add_query_arg( array(), $GLOBALS[ 'pagenow' ] );
+            wp_die( $this->_getWarnings()."<p><a href='$_sPluginListingPage'>Go back</a>.</p>" );
             
         }
         

include/class/admin/_abstract/AdminPageFrameworkLoader_AdminPage_Page_Base.php

Doc Comments +1 added lines

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

Spacing +3 added lines, -3 removed lines

@@ -29,7 +29,7 @@ 
     public function __construct( $oFactory, array $aPageArguments ) {
         
         $this->oFactory     = $oFactory;
-        $this->sPageSlug    = $aPageArguments['page_slug'];
+        $this->sPageSlug    = $aPageArguments[ 'page_slug' ];
         $this->_addPage( $aPageArguments );
         $this->construct( $oFactory );
         
@@ -58,8 +58,8 @@ 
      */
     public function replyToLoadResources( $oFactory ) {
 
-        $_sCSSPath = AdminPageFrameworkLoader_Registry::$sDirPath . '/asset/css/' . $this->sPageSlug . '.css';
-        if ( ! file_exists( $_sCSSPath ) ) {
+        $_sCSSPath = AdminPageFrameworkLoader_Registry::$sDirPath.'/asset/css/'.$this->sPageSlug.'.css';
+        if ( !file_exists( $_sCSSPath ) ) {
             return;
         }
         $this->oFactory->enqueueStyle( 

include/class/admin/admin-page-framework/addon/AdminPageFrameworkLoader_AdminPage_Addon.php

Spacing +2 added lines, -2 removed lines

@@ -19,8 +19,8 @@
     public function replyToLoadPage( $oFactory ) {
         
         new AdminPageFrameworkLoader_AdminPage_Addon_Top( 
-            $oFactory,          // factory object
-            $this->sPageSlug,   // page slug
+            $oFactory, // factory object
+            $this->sPageSlug, // page slug
             array(              // tab definition
                 'tab_slug'      => 'top',
                 'title'         => __( 'Add Ons', 'admin-page-framework-loader' ),

include/class/admin/_abstract/AdminPageFrameworkLoader_AdminPage_Section_Base.php

Spacing +4 added lines, -4 removed lines

@@ -47,7 +47,7 @@ 
         $this->sTabSlug     = $aSectionDefinition[ 'tab_slug' ];
         $this->sSectionID   = $aSectionDefinition[ 'section_id' ];
         
-        if ( ! $this->sSectionID ) {
+        if ( !$this->sSectionID ) {
             return;
         }
         $this->_addSection( $oFactory, $sPageSlug, $aSectionDefinition );
@@ -60,14 +60,14 @@ 
         
         add_action( 
             // 'validation_' . $this->sPageSlug . '_' . $this->sTabSlug, 
-            'validation_' . $oFactory->oProp->sClassName . '_' . $this->sSectionID,
+            'validation_'.$oFactory->oProp->sClassName.'_'.$this->sSectionID,
             array( $this, 'validate' ), 
             10, 
             4 
         );
         
         $oFactory->addSettingSections(
-            $sPageSlug,    // target page slug
+            $sPageSlug, // target page slug
             $aSectionDefinition
         );        
         
@@ -96,7 +96,7 @@ 
         $_aErrors   = array();
                  
         // An invalid value is found. Set a field error array and an admin notice and return the old values.
-        if ( ! $_bVerified ) {
+        if ( !$_bVerified ) {
             $oFactory->setFieldErrors( $_aErrors );     
             $oFactory->setSettingNotice( __( 'There was something wrong with your input.', 'admin-page-framework-loader' ) );
             return $aOldInput;

include/class/admin/_abstract/AdminPageFrameworkLoader_AdminPage_Tab_Base.php

Spacing +2 added lines, -2 removed lines

@@ -49,7 +49,7 @@ 
             ? $aTabDefinition[ 'tab_slug' ] 
             : '';
         
-        if ( ! $this->sTabSlug ) {
+        if ( !$this->sTabSlug ) {
             return;
         }
         
@@ -72,7 +72,7 @@ 
             
         if ( $aTabDefinition[ 'tab_slug' ] ) {
             add_action( 
-                "load_{$sPageSlug}_{$aTabDefinition['tab_slug']}",
+                "load_{$sPageSlug}_{$aTabDefinition[ 'tab_slug' ]}",
                 array( $this, 'replyToLoadTab' ) 
             );
             add_action( 

include/class/option/AdminPageFrameworkLoader_Option.php

Spacing +19 added lines, -19 removed lines

@@ -28,11 +28,11 @@ 
      * Stores the option values.
      */
     public $aOptions = array(
-        'welcomed'              => false,       // if the welcome screen is displayed, this will be true.
-        'enable_admin_pages'    => true,        // whether or not to enable the admin pages of the loader plugin.
+        'welcomed'              => false, // if the welcome screen is displayed, this will be true.
+        'enable_admin_pages'    => true, // whether or not to enable the admin pages of the loader plugin.
         'enable_demo'           => false,
-        'version_upgraded_from' => null,        // the version number that the user has upgraded from
-        'version_saved'         => null,        // represents the option version.
+        'version_upgraded_from' => null, // the version number that the user has upgraded from
+        'version_saved'         => null, // represents the option version.
     );
          
     /**
@@ -52,7 +52,7 @@ 
      * 
      * @since      3.5.0
      */
-    static public function getInstance( $sOptionKey='' ) {
+    static public function getInstance( $sOptionKey = '' ) {
         
         $sOptionKey = $sOptionKey 
             ? $sOptionKey
@@ -73,7 +73,7 @@ 
      */
     public function __construct( $sOptionKey ) {
         
-        $this->bIsNetworkAdmin  = is_network_admin();   // must be done first
+        $this->bIsNetworkAdmin  = is_network_admin(); // must be done first
         $this->sOptionKey       = $sOptionKey;
         $this->aOptions         = $this->_getFormattedOptions( $sOptionKey );
          
@@ -98,8 +98,8 @@ 
      */
     public function hasUpgraded() {
         
-        $_sOptionVersion  = $this->get( 'version_saved' );
-        if ( ! $_sOptionVersion ) {
+        $_sOptionVersion = $this->get( 'version_saved' );
+        if ( !$_sOptionVersion ) {
             return false;
         }
         $_sOptionVersion        = $this->_getVersionByDepth( $_sOptionVersion );
@@ -111,8 +111,8 @@ 
          * Returns a stating part of version by the given depth.
          * @since       3.5.0
          */
-        private function _getVersionByDepth( $sVersion, $iDepth=2 ) {
-            if ( ! $iDepth ) {
+        private function _getVersionByDepth( $sVersion, $iDepth = 2 ) {
+            if ( !$iDepth ) {
                 return $sVersion;
             }
             $_aParts = explode( '.', $sVersion );
@@ -123,7 +123,7 @@ 
     /**
      * Deletes the option from the database.
      */
-    public function delete()  {
+    public function delete() {
         return $this->bIsNetworkAdmin
             ? delete_site_option( $this->sOptionKey )
             : delete_option( $this->sOptionKey );
@@ -132,7 +132,7 @@ 
     /**
      * Saves the options.
      */
-    public function save( $aOptions=null ) {
+    public function save( $aOptions = null ) {
 
         $_aOptions = $aOptions ? $aOptions : $this->aOptions;
         return $this->bIsNetworkAdmin
@@ -151,15 +151,15 @@ 
      */
     public function set( /* $asKeys, $mValue */ ) {
         
-        $_aParameters   = func_get_args();
-        if ( ! isset( $_aParameters[ 0 ], $_aParameters[ 1 ] ) ) {
+        $_aParameters = func_get_args();
+        if ( !isset( $_aParameters[ 0 ], $_aParameters[ 1 ] ) ) {
             return;
         }
         $_asKeys        = $_aParameters[ 0 ];
         $_mValue        = $_aParameters[ 1 ];
         
         // string, integer, float, boolean
-        if ( ! is_array( $_asKeys ) ) {
+        if ( !is_array( $_asKeys ) ) {
             $this->aOptions[ $_asKeys ] = $_mValue;
             return;
         }
@@ -174,8 +174,8 @@ 
      */
     public function update( /* $asKeys, $mValue */ ) {
         
-        $_aParameters   = func_get_args();
-        call_user_func_array( array( $this, 'set' ),  $_aParameters );
+        $_aParameters = func_get_args();
+        call_user_func_array( array( $this, 'set' ), $_aParameters );
         $this->save();
 
     }
@@ -189,11 +189,11 @@ 
         
         $_mDefault  = null;
         $_aKeys     = func_get_args();
-        if ( ! isset( $_aKeys[ 0 ] ) ) {
+        if ( !isset( $_aKeys[ 0 ] ) ) {
             return null;
         }
         if ( is_array( $_aKeys[ 0 ] ) ) {
-            $_aKeys     =  $_aKeys[ 0 ];
+            $_aKeys     = $_aKeys[ 0 ];
             $_mDefault  = isset( $_aKeys[ 1 ] )
                 ? $_aKeys[ 1 ]
                 : null;

Braces +1 added lines, -1 removed lines

@@ -123,7 +123,7 @@
     /**
      * Deletes the option from the database.
      */
-    public function delete()  {
+    public function delete() {
         return $this->bIsNetworkAdmin
             ? delete_site_option( $this->sOptionKey )
             : delete_option( $this->sOptionKey );

development/factory/network_admin_page/_model/AdminPageFramework_Property_network_admin_page.php

Spacing +2 added lines, -2 removed lines

@@ -46,7 +46,7 @@ 
                 $GLOBALS, 
                 array( 'aAdminPageFramework', 'aPageClasses', $this->sClassName ) 
             ),
-            'options_' . $this->sClassName, // options_{instantiated class name}
+            'options_'.$this->sClassName, // options_{instantiated class name}
             $this->sOptionKey 
                 ? get_site_option( $this->sOptionKey, array() ) 
                 : array()
@@ -64,7 +64,7 @@ 
      * @since       3.1.1       Made it return a boolean value.
      * @return      boolean     True if saved; otherwise, false.
      */
-    public function updateOption( $aOptions=null ) {
+    public function updateOption( $aOptions = null ) {
         
         if ( $this->_bDisableSavingOptions ) {
             return;

development/factory/user_meta/AdminPageFramework_UserMeta_Router.php

Spacing +8 added lines, -8 removed lines

@@ -27,7 +27,7 @@ 
         
         parent::__construct( $oProp );
         
-        if ( ! $this->oProp->bIsAdmin ) {
+        if ( !$this->oProp->bIsAdmin ) {
             return;
         }
         
@@ -37,7 +37,7 @@ 
         );
         
         // 3.7.10+
-        add_action( 'set_up_' . $this->oProp->sClassName, array( $this, '_replyToSetUpHooks' ) );
+        add_action( 'set_up_'.$this->oProp->sClassName, array( $this, '_replyToSetUpHooks' ) );
                         
     }
     
@@ -50,7 +50,7 @@ 
      */
     public function _isInThePage() {
                
-        if ( ! $this->oProp->bIsAdmin ) {
+        if ( !$this->oProp->bIsAdmin ) {
             return false;
         }
 
@@ -71,14 +71,14 @@ 
     public function _replyToSetUpHooks( $oFactory ) {
         
         // Hooks to display fields.
-        add_action( 'show_user_profile', array( $this, '_replyToPrintFields' ) );   // profile.php
-        add_action( 'edit_user_profile', array( $this, '_replyToPrintFields' ) );   // profile.php
-        add_action( 'user_new_form', array( $this, '_replyToPrintFields' ) );   // user-new.php
+        add_action( 'show_user_profile', array( $this, '_replyToPrintFields' ) ); // profile.php
+        add_action( 'edit_user_profile', array( $this, '_replyToPrintFields' ) ); // profile.php
+        add_action( 'user_new_form', array( $this, '_replyToPrintFields' ) ); // user-new.php
         
         // Hooks to save field values.
         add_action( 'personal_options_update', array( $this, '_replyToSaveFieldValues' ) ); // profile.php
-        add_action( 'edit_user_profile_update', array( $this, '_replyToSaveFieldValues' ) );    // profile.php
-        add_action('user_register', array( $this, '_replyToSaveFieldValues' ) );    // user-new.php
+        add_action( 'edit_user_profile_update', array( $this, '_replyToSaveFieldValues' ) ); // profile.php
+        add_action( 'user_register', array( $this, '_replyToSaveFieldValues' ) ); // user-new.php
                        
     }