michaeluno / admin-page-framework

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

Spacing +47 added lines, -47 removed lines

@@ -27,7 +27,7 @@ 
      * 
      * @internal
      */
-    public function __construct( $oFactory, $sActionHook='admin_menu' ) {
+    public function __construct( $oFactory, $sActionHook = 'admin_menu' ) {
         
         $this->oFactory = $oFactory;
         
@@ -75,7 +75,7 @@ 
     public function _replyToRegisterRootMenu() {
         
         // If the root menu label is not set but the slug is set, 
-        if ( ! $this->oFactory->oProp->aRootMenu[ 'fCreateRoot' ] ) {
+        if ( !$this->oFactory->oProp->aRootMenu[ 'fCreateRoot' ] ) {
             return;
         }
         $this->_registerRootMenuPage();
@@ -97,12 +97,12 @@ 
             }
 
             $this->oFactory->oProp->aRootMenu[ '_page_hook' ] = add_menu_page(  
-                $this->oFactory->oProp->sClassName,                 // Page title - will be invisible anyway
-                $this->oFactory->oProp->aRootMenu[ 'sTitle' ],      // Menu title - should be the root page title.
-                $this->oFactory->oProp->sCapability,                // Capability - access right
-                $this->oFactory->oProp->aRootMenu[ 'sPageSlug' ],   // Menu ID 
-                '',                                       // Callback function for the page content output - the root page will be removed so no need to register a function.
-                $this->oFactory->oProp->aRootMenu[ 'sIcon16x16' ],  // icon path
+                $this->oFactory->oProp->sClassName, // Page title - will be invisible anyway
+                $this->oFactory->oProp->aRootMenu[ 'sTitle' ], // Menu title - should be the root page title.
+                $this->oFactory->oProp->sCapability, // Capability - access right
+                $this->oFactory->oProp->aRootMenu[ 'sPageSlug' ], // Menu ID 
+                '', // Callback function for the page content output - the root page will be removed so no need to register a function.
+                $this->oFactory->oProp->aRootMenu[ 'sIcon16x16' ], // icon path
                 $this->getElement( 
                     $this->oFactory->oProp->aRootMenu, 
                     'iPosition', 
@@ -124,8 +124,8 @@ 
 
         // Let external scripts add sub-menu pages.
         $_aPages = $this->addAndApplyFilter( 
-            $this->oFactory,    // caller object
-            "pages_{$this->oFactory->oProp->sClassName}",   // filter
+            $this->oFactory, // caller object
+            "pages_{$this->oFactory->oProp->sClassName}", // filter
             $this->oFactory->oProp->aPages  // arguments
         );
         
@@ -135,7 +135,7 @@ 
         // Format the `$aPages` property and register the pages.
         $_iParsedIndex    = 0;
         $_aFormattedPages = array();
-        foreach( $_aPages as $_aSubMenuItem ) {
+        foreach ( $_aPages as $_aSubMenuItem ) {
             
             // needs to be sanitized because there are hook filters applied to this array.
             $_oFormatter = new AdminPageFramework_Format_SubMenuItem( 
@@ -170,8 +170,8 @@ 
          */
         private function _getDefaultPageSlug( array $aPages ) {
 
-            foreach( $aPages as $_aPage ) {
-                if ( ! isset( $_aPage[ 'page_slug' ] ) ) { 
+            foreach ( $aPages as $_aPage ) {
+                if ( !isset( $_aPage[ 'page_slug' ] ) ) { 
                     continue; 
                 }
                 return $_aPage[ 'page_slug' ];                
@@ -193,7 +193,7 @@ 
          */ 
         private function _registerSubMenuItem( array $aArgs ) {
 
-            if ( ! current_user_can( $aArgs[ 'capability' ] ) ) {
+            if ( !current_user_can( $aArgs[ 'capability' ] ) ) {
                 return '';
             }
                                     
@@ -257,14 +257,14 @@ 
              */
             private function _addPageSubmenuItem( $sRootPageSlug, $sMenuSlug, $sPageSlug, $sPageTitle, $sMenuTitle, $sCapability, $bShowInMenu, $nOrder ) {
                 
-                if ( ! $sPageSlug ) {
+                if ( !$sPageSlug ) {
                     return '';
                 }
                 $_sPageHook = $this->___addSubMenuPage(
-                    $sRootPageSlug,         // the root (parent) page slug
-                    $sPageTitle,            // page title
-                    $sMenuTitle,            // menu title
-                    $sCapability,           // capability
+                    $sRootPageSlug, // the root (parent) page slug
+                    $sPageTitle, // page title
+                    $sMenuTitle, // menu title
+                    $sCapability, // capability
                     $sPageSlug              // menu slug
                 );
 
@@ -293,14 +293,14 @@ 
                 $_aRemovedMenuItem = $this->_removePageSubmenuItem( $_nSubMenuPageIndex, $sMenuSlug, $sPageSlug, $sMenuTitle );
                 
                 // If the visibility option is `false`, remove the one just added from the sub-menu global array
-                if ( ! $bShowInMenu && ! $this->_isCurrentPage( $sPageSlug ) ) {
+                if ( !$bShowInMenu && !$this->_isCurrentPage( $sPageSlug ) ) {
                     return $_sPageHook;
                 }                
                 
                 // Set the order index in the element of the `submenu` global array.
                 $this->_setSubMenuPageByIndex( 
-                    $nOrder,                // user-set order
-                    $_aRemovedMenuItem,     // will be reassign with a new index
+                    $nOrder, // user-set order
+                    $_aRemovedMenuItem, // will be reassign with a new index
                     $sMenuSlug
                 );
 
@@ -321,21 +321,21 @@ 
                  * @uses        add_submenu_page
                  */
                 private function ___addSubMenuPage(
-                    $sRootPageSlug,         // the root (parent) page slug
-                    $sPageTitle,            // page title
-                    $sMenuTitle,            // menu title
-                    $sCapability,           // capability
+                    $sRootPageSlug, // the root (parent) page slug
+                    $sPageTitle, // page title
+                    $sMenuTitle, // menu title
+                    $sCapability, // capability
                     $sPageSlug              // menu slug
                 ) {
                     if ( $this->oFactory->oProp->bIsAdminAjax ) {
                         return $sPageSlug;
                     }
                     return add_submenu_page(
-                        $sRootPageSlug,         // the root (parent) page slug
-                        $sPageTitle,            // page title
-                        $sMenuTitle,            // menu title
-                        $sCapability,           // capability
-                        $sPageSlug,             // menu slug
+                        $sRootPageSlug, // the root (parent) page slug
+                        $sPageTitle, // page title
+                        $sMenuTitle, // menu title
+                        $sCapability, // capability
+                        $sPageSlug, // menu slug
                         array( $this->oFactory, '_replyToRenderPage' )  // callback 3.7.10+
                     );
                 }
@@ -369,7 +369,7 @@ 
                      */
                     add_action( 
                         'current_screen', 
-                        array( $this->oFactory, "load_pre_" . $sPageSlug ), 
+                        array( $this->oFactory, "load_pre_".$sPageSlug ), 
                         20 
                     );
                     /**
@@ -378,7 +378,7 @@ 
                      */
                     add_action(
                         'pseudo_current_screen',
-                        array( $this->oFactory, "load_pre_" . $sPageSlug ),
+                        array( $this->oFactory, "load_pre_".$sPageSlug ),
                         20
                     );
                     
@@ -387,15 +387,15 @@ 
                      * Set a low priority because the user may add in-page tabs in their callback method of this action hook.
                      * @since       3.6.3
                      */
-                    add_action( "load_" . $sPageSlug, array( $this->oFactory, '_replyToFinalizeInPageTabs' ), 9999 );
+                    add_action( "load_".$sPageSlug, array( $this->oFactory, '_replyToFinalizeInPageTabs' ), 9999 );
                     
                     // 3.6.3+
-                    add_action( "load_after_" . $sPageSlug, array( $this->oFactory, '_replyToEnqueuePageAssets' ) );
-                    add_action( "load_after_" . $sPageSlug, array( $this->oFactory, '_replyToEnablePageMetaBoxes' ) );  // 3.7.10+
+                    add_action( "load_after_".$sPageSlug, array( $this->oFactory, '_replyToEnqueuePageAssets' ) );
+                    add_action( "load_after_".$sPageSlug, array( $this->oFactory, '_replyToEnablePageMetaBoxes' ) ); // 3.7.10+
                           
                     $this->oFactory->oProp->aPageHooks[ $sPageSlug ] = $this->getAOrB(
                         is_network_admin(),
-                        $sPageHook . '-network',
+                        $sPageHook.'-network',
                         $sPageHook
                     );                          
 
@@ -412,7 +412,7 @@ 
 
                     $_nNewIndex = $this->getUnusedNumericIndex( 
                         $this->getElementAsArray( $GLOBALS, array( 'submenu', $sMenuSlug ) ), // subject array to parser
-                        $nOrder,    // a desired menu position
+                        $nOrder, // a desired menu position
                         5           // offset 
                     );
 
@@ -426,9 +426,9 @@ 
                  */
                 private function _getSubMenuPageIndex( $sMenuSlug, $sMenuTitle, $sPageTitle, $sPageSlug ) {
                     
-                    foreach( $this->getElementAsArray( $GLOBALS, array( 'submenu', $sMenuSlug ) ) as $_iIndex => $_aSubMenu ) {
+                    foreach ( $this->getElementAsArray( $GLOBALS, array( 'submenu', $sMenuSlug ) ) as $_iIndex => $_aSubMenu ) {
                       
-                        if ( ! isset( $_aSubMenu[ 3 ] ) ) { 
+                        if ( !isset( $_aSubMenu[ 3 ] ) ) { 
                             continue; 
                         }
                                                
@@ -460,7 +460,7 @@ 
                  * @since       3.1.1       Moved from `AdminPageFramework_Menu`. Chagned the return type.
                  * @return      array       removed menu item.
                  */
-                private function _removePageSubmenuItem( $nSubMenuPageIndex, $sMenuSlug, $sPageSlug, $sMenuTitle ){
+                private function _removePageSubmenuItem( $nSubMenuPageIndex, $sMenuSlug, $sPageSlug, $sMenuTitle ) {
  
                     $_aRemovedMenuItem = $this->_removePageSubMenuItemByIndex( 
                         $nSubMenuPageIndex,
@@ -533,7 +533,7 @@ 
              */
             private function _addLinkSubmenuItem( $sMenuSlug, $sTitle, $sCapability, $sHref, $bShowInMenu, $nOrder ) {
                 
-                if ( ! $bShowInMenu ) {
+                if ( !$bShowInMenu ) {
                     return;
                 }
     
@@ -548,9 +548,9 @@ 
                     5   // offset
                 );
                 $_aSubMenuItems[ $_nIndex ] = array(
-                    $sTitle,        // 0
-                    $sCapability,   // 1
-                    $sHref,         // 2   
+                    $sTitle, // 0
+                    $sCapability, // 1
+                    $sHref, // 2   
                 );
                 $GLOBALS[ 'submenu' ][ $sMenuSlug ] = $_aSubMenuItems;                
                 
@@ -569,7 +569,7 @@ 
     public function _replyToRemoveRootMenuPage() {      
         
         // After adding the sub menus, if the root menu is created, remove the page that is automatically created when registering the root menu.
-        if ( ! $this->oFactory->oProp->aRootMenu[ 'fCreateRoot' ] ) {
+        if ( !$this->oFactory->oProp->aRootMenu[ 'fCreateRoot' ] ) {
             return;
         }
         if ( $this->oFactory->oProp->bIsAdminAjax ) {
@@ -580,7 +580,7 @@ 
          * Namespace slugs have backslashes but the registered slugs backslashes are all converted to forward-slashes.
          * @since       3.5.16
          */
-        $_sMenuSlug =             str_replace(
+        $_sMenuSlug = str_replace(
             '\\',
             '/',
             $this->oFactory->oProp->aRootMenu[ 'sPageSlug' ]

admin-page-framework-loader.php

Spacing +22 added lines, -22 removed lines

@@ -16,9 +16,9 @@ 
  */
 class AdminPageFrameworkLoader_Registry_Base {
 
-    const VERSION        = '3.8.16b01';    // <--- DON'T FORGET TO CHANGE THIS AS WELL!!
+    const VERSION        = '3.8.16b01'; // <--- DON'T FORGET TO CHANGE THIS AS WELL!!
     const NAME           = 'Admin Page Framework - Loader'; // the name is not 'Admin Page Framework' because warning messages gets confusing.
-    const SHORTNAME      = 'Admin Page Framework';  // used for a menu title etc.
+    const SHORTNAME      = 'Admin Page Framework'; // used for a menu title etc.
     const DESCRIPTION    = 'Loads Admin Page Framework which facilitates WordPress plugin and theme development.';
     const URI            = 'http://admin-page-framework.michaeluno.jp/';
     const AUTHOR         = 'miunosoft (Michael Uno)';
@@ -55,14 +55,14 @@ 
      * @remark      This is also accessed from `uninstall.php` so do not remove.
      * @remark      Do not exceed 8 characters as a transient name allows 45 characters or less ( 40 for site transients ) so that md5 (32 characters) can be added.
      */
-    const TRANSIENT_PREFIX         = 'APFL_';
+    const TRANSIENT_PREFIX = 'APFL_';
 
     /**
      * The hook slug used for the prefix of action and filter hook names.
      * 
      * @remark      The ending underscore is not necessary.
      */
-    const HOOK_SLUG                = 'admin_page_framework_loader';
+    const HOOK_SLUG = 'admin_page_framework_loader';
 
     /**
      * The text domain slug and its path.
@@ -116,7 +116,7 @@ 
      */
     static public $aAdminPages = array(
         // key => 'page slug'
-        'about'     => 'apfl_about',        // the welcome page
+        'about'     => 'apfl_about', // the welcome page
         'addon'     => 'apfl_addons',
         'tool'      => 'apfl_tools',
         'help'      => 'apfl_contact',
@@ -154,12 +154,12 @@ 
      * @since       3.5.0
      * @return      string
      */
-    public static function getPluginURL( $sRelativePath='' ) {
+    public static function getPluginURL( $sRelativePath = '' ) {
         if ( isset( self::$_sPluginURLCache ) ) {
-            return self::$_sPluginURLCache . $sRelativePath;
+            return self::$_sPluginURLCache.$sRelativePath;
         }
         self::$_sPluginURLCache = trailingslashit( plugins_url( '', self::$sFilePath ) );
-        return self::$_sPluginURLCache . $sRelativePath;
+        return self::$_sPluginURLCache.$sRelativePath;
     }
         /**
          * @since       3.7.9
@@ -189,13 +189,13 @@ 
      * @since       3.5.0
      * @return      void
      */ 
-    static public function setAdminNotice( $sMessage, $sClassAttribute='error' ) {
-        if ( ! is_admin() ) {  
+    static public function setAdminNotice( $sMessage, $sClassAttribute = 'error' ) {
+        if ( !is_admin() ) {  
             return; 
         }
-        self::$_aAdminNotices[] = array(
+        self::$_aAdminNotices[ ] = array(
             'message'           => $sMessage,
-            'class_attribute'   => trim( $sClassAttribute ) . ' notice is-dismissible',
+            'class_attribute'   => trim( $sClassAttribute ).' notice is-dismissible',
         );
         add_action( 'admin_notices', array( __CLASS__, '_replyToSetAdminNotice' ) );
     }
@@ -205,12 +205,12 @@ 
          * @return      void
          */
         static public function _replyToSetAdminNotice() {
-            foreach( self::$_aAdminNotices as $_aAdminNotice ) {
-                echo "<div class='" . esc_attr( $_aAdminNotice['class_attribute'] ) . " notice is-dismissible'>"
+            foreach ( self::$_aAdminNotices as $_aAdminNotice ) {
+                echo "<div class='".esc_attr( $_aAdminNotice[ 'class_attribute' ] )." notice is-dismissible'>"
                         ."<p>"
                             . sprintf(
-                                '<strong>%1$s</strong>: ' . $_aAdminNotice['message'],
-                                self::NAME . ' ' . self::VERSION
+                                '<strong>%1$s</strong>: '.$_aAdminNotice[ 'message' ],
+                                self::NAME.' '.self::VERSION
                             )
                         . "</p>"
                     . "</div>";
@@ -222,7 +222,7 @@ 
 AdminPageFrameworkLoader_Registry::setUp( __FILE__ );
 
 // Initial checks. - Do no load if accessed directly, not exiting because the 'uninstall.php' and inclusion list generator will load this file.
-if ( ! defined( 'ABSPATH' ) ) {
+if ( !defined( 'ABSPATH' ) ) {
     return;
 }
 if ( defined( 'DOING_UNINSTALL' ) && DOING_UNINSTALL ) {
@@ -234,8 +234,8 @@ 
 
     $_bFrameworkLoaded = class_exists( 'AdminPageFramework_Registry', false );
     if (
-        ! $_bFrameworkLoaded
-        || ! defined( 'AdminPageFramework_Registry::VERSION' ) // backward compatibility
+        !$_bFrameworkLoaded
+        || !defined( 'AdminPageFramework_Registry::VERSION' ) // backward compatibility
         || version_compare( AdminPageFramework_Registry::VERSION, AdminPageFrameworkLoader_Registry::VERSION, '<' )
     ) {
         AdminPageFrameworkLoader_Registry::setAdminNotice(
@@ -253,18 +253,18 @@ 
 add_action( 'admin_init', 'AdminPageFrameworkLoader_Warning' );
 
 // Include the library file - the development version will be available if you cloned the GitHub repository.
-$_sDevelopmentVersionPath = AdminPageFrameworkLoader_Registry::$sDirPath . '/development/admin-page-framework.php';
+$_sDevelopmentVersionPath = AdminPageFrameworkLoader_Registry::$sDirPath.'/development/admin-page-framework.php';
 $_bDebugMode              = defined( 'WP_DEBUG' ) && WP_DEBUG;
 $_bLoadDevelopmentVersion = $_bDebugMode && file_exists( $_sDevelopmentVersionPath );
 include(
     $_bLoadDevelopmentVersion
         ? $_sDevelopmentVersionPath
-        : AdminPageFrameworkLoader_Registry::$sDirPath . '/library/apf/admin-page-framework.php'
+        : AdminPageFrameworkLoader_Registry::$sDirPath.'/library/apf/admin-page-framework.php'
 );
 
 // Include the framework loader plugin components.
 include( AdminPageFramework_Registry::$aClassFiles[ 'AdminPageFramework_PluginBootstrap' ] );
-include( AdminPageFrameworkLoader_Registry::$sDirPath . '/include/class/AdminPageFrameworkLoader_Bootstrap.php' );
+include( AdminPageFrameworkLoader_Registry::$sDirPath.'/include/class/AdminPageFrameworkLoader_Bootstrap.php' );
 new AdminPageFrameworkLoader_Bootstrap(
     AdminPageFrameworkLoader_Registry::$sFilePath,
     AdminPageFrameworkLoader_Registry::HOOK_SLUG    // hook prefix