michaeluno / admin-page-framework

development/factory/meta_box/AdminPageFramework_MetaBox_View.php

Braces +1 added lines, -1 removed lines

@@ -27,7 +27,7 @@
      * @return      void
      * @internal    
      */ 
-    public function _replyToPrintMetaBoxContents( $oPost, $vArgs ) {    
+    public function _replyToPrintMetaBoxContents( $oPost, $vArgs ) {
 
         // Use nonce for verification
         $_aOutput   = array();

Spacing +3 added lines, -3 removed lines

@@ -31,7 +31,7 @@ 
 
         // Use nonce for verification
         $_aOutput   = array();
-        $_aOutput[] = wp_nonce_field(
+        $_aOutput[ ] = wp_nonce_field(
             $this->oProp->sMetaBoxID, 
             $this->oProp->sMetaBoxID, 
             true, 
@@ -40,11 +40,11 @@ 
                                  
         // Get the fields output. If no field is added, the form object is not instantiated.
         if ( isset( $this->oForm ) ) {
-            $_aOutput[] = $this->oForm->get();
+            $_aOutput[ ] = $this->oForm->get();
         }
 
         // Do actions
-        $this->oUtil->addAndDoActions( $this, 'do_' . $this->oProp->sClassName, $this );
+        $this->oUtil->addAndDoActions( $this, 'do_'.$this->oProp->sClassName, $this );
         
         // Render the filtered output.
         echo $this->oUtil->addAndApplyFilters(

development/factory/meta_box/form/_view/AdminPageFramework_Form_View___CSS_meta_box.php

Braces +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
      * @since       DEVVER
      * @return      string
      */
-    protected function _get() {        
+    protected function _get() {
         return $this->_getRules();
     }
         /**

development/factory/network_admin_page/AdminPageFramework_NetworkAdmin.php

Braces +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
      * @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`.
      * @return      void        returns nothing.
      */
-    public function __construct( $sOptionKey=null, $sCallerPath=null, $sCapability='manage_network', $sTextDomain='admin-page-framework' ){
+    public function __construct( $sOptionKey=null, $sCallerPath=null, $sCapability='manage_network', $sTextDomain='admin-page-framework' ) {
             
         if ( ! $this->_isInstantiatable() ) {
             return;

Spacing +7 added lines, -7 removed lines

@@ -40,12 +40,12 @@ 
     protected $_aBuiltInRootMenuSlugs = array(
         // All keys must be lower case to support case insensitive look-ups.
         'dashboard'     => 'index.php',
-        'sites'         => 'sites.php',         // not work
-        'themes'        => 'themes.php',        // not work
+        'sites'         => 'sites.php', // not work
+        'themes'        => 'themes.php', // not work
         'plugins'       => 'plugins.php',
         'users'         => 'users.php',
         'settings'      => 'settings.php',
-        'updates'       => 'update-core.php',   // does not work
+        'updates'       => 'update-core.php', // does not work
     );     
         
     /**
@@ -66,15 +66,15 @@ 
      * @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`.
      * @return      void        returns nothing.
      */
-    public function __construct( $sOptionKey=null, $sCallerPath=null, $sCapability='manage_network', $sTextDomain='admin-page-framework' ){
+    public function __construct( $sOptionKey = null, $sCallerPath = null, $sCapability = 'manage_network', $sTextDomain = 'admin-page-framework' ) {
             
-        if ( ! $this->_isInstantiatable() ) {
+        if ( !$this->_isInstantiatable() ) {
             return;
         }
                     
         $sCallerPath = $sCallerPath 
             ? $sCallerPath 
-            : AdminPageFramework_Utility::getCallerScriptPath( __FILE__ );     // this is important to attempt to find the caller script path here when separating the library into multiple files.
+            : AdminPageFramework_Utility::getCallerScriptPath( __FILE__ ); // this is important to attempt to find the caller script path here when separating the library into multiple files.
              
         parent::__construct( $sOptionKey, $sCallerPath, $sCapability, $sTextDomain );
         
@@ -158,7 +158,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::getSiteOption( $sOptionKey, $asKey, $vDefault );
     }
     

development/factory/page_meta_box/AdminPageFramework_PageMetaBox.php

Braces +2 added lines, -2 removed lines

@@ -67,11 +67,11 @@
      */
     function __construct( $sMetaBoxID, $sTitle, $asPageSlugs=array(), $sContext='normal', $sPriority='default', $sCapability='manage_options', $sTextDomain='admin-page-framework' ) {
         
-        if ( empty( $asPageSlugs ) ) { 
+        if ( empty( $asPageSlugs ) ) {
             return; 
         }
         
-        if ( ! $this->_isInstantiatable() ) { 
+        if ( ! $this->_isInstantiatable() ) {
             return; 
         }
                 

Spacing +4 added lines, -4 removed lines

@@ -77,21 +77,21 @@
      * @param       string          $sPriority      The priority, either `high`, `core`, `default` or `low`.
      * @param       string          $sCapability    The capability. See <a href="https://codex.wordpress.org/Roles_and_Capabilities" target="_blank">Roles and Capabilities</a>.
      */
-    public function __construct( $sMetaBoxID, $sTitle, $asPageSlugs=array(), $sContext='normal', $sPriority='default', $sCapability='manage_options', $sTextDomain='admin-page-framework' ) {
+    public function __construct( $sMetaBoxID, $sTitle, $asPageSlugs = array(), $sContext = 'normal', $sPriority = 'default', $sCapability = 'manage_options', $sTextDomain = 'admin-page-framework' ) {
         
         if ( empty( $asPageSlugs ) ) { 
             return; 
         }
         
-        if ( ! $this->_isInstantiatable() ) { 
+        if ( !$this->_isInstantiatable() ) { 
             return; 
         }
                 
         // The property object needs to be done first before the parent constructor.
         $_sProprtyClassName = isset( $this->aSubClassNames[ 'oProp' ] )
             ? $this->aSubClassNames[ 'oProp' ]
-            : 'AdminPageFramework_Property_' . $this->_sStructureType;        
-        $this->oProp             = new $_sProprtyClassName( 
+            : 'AdminPageFramework_Property_'.$this->_sStructureType;        
+        $this->oProp = new $_sProprtyClassName( 
             $this, 
             get_class( $this ), 
             $sCapability, 

development/factory/page_meta_box/AdminPageFramework_PageMetaBox_Controller.php

Spacing +4 added lines, -4 removed lines

@@ -22,7 +22,7 @@ 
      * 
      * @since 3.0.0
      */
-    public function enqueueStyles( $aSRCs, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {
+    public function enqueueStyles( $aSRCs, $sPageSlug = '', $sTabSlug = '', $aCustomArgs = array() ) {
         if ( method_exists( $this->oResource, '_enqueueStyles' ) ) {
             return $this->oResource->_enqueueStyles( $aSRCs, $sPageSlug, $sTabSlug, $aCustomArgs );
         }
@@ -38,7 +38,7 @@ 
      * @param array (optional) The argument array for more advanced parameters.
      * @return string The script 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() ) {
         if ( method_exists( $this->oResource, '_enqueueStyle' ) ) {
             return $this->oResource->_enqueueStyle( $sSRC, $sPageSlug, $sTabSlug, $aCustomArgs );     
         }
@@ -48,7 +48,7 @@ 
      * 
      * @since 2.1.5
      */
-    public function enqueueScripts( $aSRCs, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {
+    public function enqueueScripts( $aSRCs, $sPageSlug = '', $sTabSlug = '', $aCustomArgs = array() ) {
         if ( method_exists( $this->oResource, '_enqueueScripts' ) ) {
             return $this->oResource->_enqueueScripts( $sSRC, $sPageSlug, $sTabSlug, $aCustomArgs );
         }
@@ -64,7 +64,7 @@ 
      * @param             array (optional) The argument array for more advanced parameters.
      * @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() ) {    
         if ( method_exists( $this->oResource, '_enqueueScript' ) ) {
             return $this->oResource->_enqueueScript( $sSRC, $sPageSlug, $sTabSlug, $aCustomArgs );
         }

Braces +1 added lines, -1 removed lines

@@ -64,7 +64,7 @@
      * @param             array (optional) The argument array for more advanced parameters.
      * @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() ) {
         if ( method_exists( $this->oResource, '_enqueueScript' ) ) {
             return $this->oResource->_enqueueScript( $sSRC, $sPageSlug, $sTabSlug, $aCustomArgs );
         }

development/factory/page_meta_box/AdminPageFramework_PageMetaBox_Model.php

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

@@ -46,11 +46,11 @@ 
     public function _replyToSetUpValidationHooks( $oScreen ) {
 
         // Validation hooks
-        foreach( $this->oProp->aPageSlugs as $_sIndexOrPageSlug => $_asTabArrayOrPageSlug ) {
+        foreach ( $this->oProp->aPageSlugs as $_sIndexOrPageSlug => $_asTabArrayOrPageSlug ) {
             
             if ( is_scalar( $_asTabArrayOrPageSlug ) ) {
                 $_sPageSlug = $_asTabArrayOrPageSlug;
-                add_filter( "validation_saved_options_without_dynamic_elements_{$_sPageSlug}", array( $this, '_replyToFilterPageOptionsWODynamicElements' ), 10, 2 );  // 3.4.1+
+                add_filter( "validation_saved_options_without_dynamic_elements_{$_sPageSlug}", array( $this, '_replyToFilterPageOptionsWODynamicElements' ), 10, 2 ); // 3.4.1+
                 add_filter( "validation_{$_sPageSlug}", array( $this, '_replyToValidateOptions' ), 10, 4 );
                 add_filter( "options_update_status_{$_sPageSlug}", array( $this, '_replyToModifyOptionsUpdateStatus' ) );
                 continue;
@@ -59,7 +59,7 @@ 
             // At this point, the array key is the page slug. It means the user specified the tab(s).
             $_sPageSlug = $_sIndexOrPageSlug;
             $_aTabs     = $_asTabArrayOrPageSlug;
-            foreach( $_aTabs as $_sTabSlug ) {
+            foreach ( $_aTabs as $_sTabSlug ) {
                 add_filter( "validation_{$_sPageSlug}_{$_sTabSlug}", array( $this, '_replyToValidateOptions' ), 10, 4 );
                 add_filter( "validation_saved_options_without_dynamic_elements_{$_sPageSlug}_{$_sTabSlug}", array( $this, '_replyToFilterPageOptionsWODynamicElements' ), 10, 2 ); // 3.4.1+
                 add_filter( "options_update_status_{$_sPageSlug}_{$_sTabSlug}", array( $this, '_replyToModifyOptionsUpdateStatus' ) );
@@ -79,9 +79,9 @@ 
      * @return      void
      * @callback    action      add_meta_boxes
      */ 
-    public function _replyToRegisterMetaBoxes( $sPageHook='' ) {
-        foreach( $this->oProp->aPageSlugs as $_sKey => $_asPage ) {
-            if ( is_string( $_asPage ) )  {
+    public function _replyToRegisterMetaBoxes( $sPageHook = '' ) {
+        foreach ( $this->oProp->aPageSlugs as $_sKey => $_asPage ) {
+            if ( is_string( $_asPage ) ) {
                 $this->_registerMetaBox( $_asPage );
                 continue;
             }            
@@ -97,8 +97,8 @@ 
          * @return      void
          */
         private function _registerMetaBoxes( $sPageSlug, $asPage ) {
-            foreach( $this->oUtil->getAsArray( $asPage ) as $_sTabSlug ) {
-                if ( ! $this->oProp->isCurrentTab( $_sTabSlug ) ) { 
+            foreach ( $this->oUtil->getAsArray( $asPage ) as $_sTabSlug ) {
+                if ( !$this->oProp->isCurrentTab( $_sTabSlug ) ) { 
                     continue; 
                 }
                 $this->_registerMetaBox( $sPageSlug );
@@ -115,12 +115,12 @@ 
          */
         private function _registerMetaBox( $sPageSlug ) {
             add_meta_box( 
-                $this->oProp->sMetaBoxID,                       // id
-                $this->oProp->sTitle,                           // title
+                $this->oProp->sMetaBoxID, // id
+                $this->oProp->sTitle, // title
                 array( $this, '_replyToPrintMetaBoxContents' ), // callback
                 $this->oProp->_getScreenIDOfPage( $sPageSlug ), // screen ID
-                $this->oProp->sContext,                         // context
-                $this->oProp->sPriority,                        // priority
+                $this->oProp->sContext, // context
+                $this->oProp->sPriority, // priority
                 null                                            // argument (deprecated)
             );
         }
@@ -168,17 +168,17 @@ 
         
         $_aNewMetaBoxInputs      = $this->oForm->getSubmittedData( $_POST );
         $_aOldMetaBoxInputs      = $this->oUtil->castArrayContents( 
-            $this->oForm->getDataStructureFromAddedFieldsets(),   // model
+            $this->oForm->getDataStructureFromAddedFieldsets(), // model
             $aOldPageOptions        // data source
         );
 
         // Apply filters - third party scripts will have access to the input.
         $_aNewMetaBoxInputsRaw   = $_aNewMetaBoxInputs; // copy one for validation errors.
         $_aNewMetaBoxInputs      = call_user_func_array( 
-            array( $this, 'validate' ),     // triggers __call()
+            array( $this, 'validate' ), // triggers __call()
             array( $_aNewMetaBoxInputs, $_aOldMetaBoxInputs, $this, $aSubmitInfo ) 
         ); // 3.5.3+
-        $_aNewMetaBoxInputs      = $this->oUtil->addAndApplyFilters( 
+        $_aNewMetaBoxInputs = $this->oUtil->addAndApplyFilters( 
             $this, 
             "validation_{$this->oProp->sClassName}", 
             $_aNewMetaBoxInputs, 
@@ -213,7 +213,7 @@ 
      */
     public function _replyToModifyOptionsUpdateStatus( $aStatus ) {
         
-        if ( ! $this->hasFieldError() ) {
+        if ( !$this->hasFieldError() ) {
             return $aStatus;
         }
         return array( 
@@ -236,11 +236,11 @@ 
     public function _replyToGetSavedFormData() {
         $_aPageOptions = $this->oUtil->addAndApplyFilter(
             $this, // the caller factory object
-            'options_' . $this->oProp->sClassName,
+            'options_'.$this->oProp->sClassName,
             $this->oProp->oAdminPage->oProp->aOptions  
         );
         return $this->oUtil->castArrayContents( 
-            $this->oForm->getDataStructureFromAddedFieldsets(),   // model
+            $this->oForm->getDataStructureFromAddedFieldsets(), // model
             $_aPageOptions        // data source
         );        
     }    
@@ -256,9 +256,9 @@ 
         private function _getPageMetaBoxOptionsFromPageOptions( array $aPageOptions, array $aFieldsets ) {
      
             $_aOptions = array();
-            foreach( $aFieldsets as $_sSectionID => $_aFieldsets ) {
-                if ( '_default' === $_sSectionID  ) {
-                    foreach( $_aFieldsets as $_aField ) {
+            foreach ( $aFieldsets as $_sSectionID => $_aFieldsets ) {
+                if ( '_default' === $_sSectionID ) {
+                    foreach ( $_aFieldsets as $_aField ) {
                         if ( array_key_exists( $_aField[ 'field_id' ], $aPageOptions ) ) {
                             $_aOptions[ $_aField[ 'field_id' ] ] = $aPageOptions[ $_aField[ 'field_id' ] ];
                         }

Braces +2 added lines, -2 removed lines

@@ -81,7 +81,7 @@ 
      */ 
     public function _replyToRegisterMetaBoxes( $sPageHook='' ) {
         foreach( $this->oProp->aPageSlugs as $_sKey => $_asPage ) {
-            if ( is_string( $_asPage ) )  {
+            if ( is_string( $_asPage ) ) {
                 $this->_registerMetaBox( $_asPage );
                 continue;
             }            
@@ -98,7 +98,7 @@ 
          */
         private function _registerMetaBoxes( $sPageSlug, $asPage ) {
             foreach( $this->oUtil->getAsArray( $asPage ) as $_sTabSlug ) {
-                if ( ! $this->oProp->isCurrentTab( $_sTabSlug ) ) { 
+                if ( ! $this->oProp->isCurrentTab( $_sTabSlug ) ) {
                     continue; 
                 }
                 $this->_registerMetaBox( $sPageSlug );

development/factory/page_meta_box/form/AdminPageFramework_Form_page_meta_box.php

Spacing +2 added lines, -2 removed lines

@@ -30,7 +30,7 @@ 
     public function construct() {
         
         add_filter(
-            'options_' . $this->aArguments[ 'caller_id' ],
+            'options_'.$this->aArguments[ 'caller_id' ],
             array( $this, '_replyToSanitizeSavedFormData' ),
             5   //  high priority as it must be done eariler
         );
@@ -54,7 +54,7 @@ 
         
         // Extract the meta box field form data (options) from the page form data (options).
         return $this->castArrayContents( 
-            $this->getDataStructureFromAddedFieldsets(),    // form data structure generate from fieldsets
+            $this->getDataStructureFromAddedFieldsets(), // form data structure generate from fieldsets
             $aSavedFormData
         );
         

development/factory/post_type/AdminPageFramework_PostType.php

Braces +2 added lines, -2 removed lines

@@ -15,7 +15,7 @@ 
  * @package         AdminPageFramework
  * @subpackage      PostType
  */
-abstract class AdminPageFramework_PostType extends AdminPageFramework_PostType_Controller {    
+abstract class AdminPageFramework_PostType extends AdminPageFramework_PostType_Controller {
         
     /**
     * The constructor of the class object.
@@ -91,7 +91,7 @@ 
     */
     public function __construct( $sPostType, $aArguments=array(), $sCallerPath=null, $sTextDomain='admin-page-framework' ) {
         
-        if ( empty( $sPostType ) ) { 
+        if ( empty( $sPostType ) ) {
             return; 
         }
 

Indentation +77 added lines, -78 removed lines

@@ -26,84 +26,83 @@
     protected $_sStructureType = 'post_type';
     
     /**
-    * The constructor of the class object.
-    * 
-    * Registers necessary hooks and sets up internal properties.
-    * 
-    * <h4>Example</h4>
-    * <code>new APF_PostType( 
-    *     'apf_posts',     // post type slug
-    *       array( 
-    *           'labels' => array(
-    *               'name'               => 'Demo',
-    *               'all_items'          => __( 'Sample Posts', 'admin-page-framework-demo' ),
-    *               'singular_name'      => 'Demo',
-    *               'add_new'            => __( 'Add New', 'admin-page-framework-demo' ),
-    *               'add_new_item'       => __( 'Add New APF Post', 'admin-page-framework-demo' ),
-    *               'edit'               => __( 'Edit', 'admin-page-framework-demo' ),
-    *               'edit_item'          => __( 'Edit APF Post', 'admin-page-framework-demo' ),
-    *               'new_item'           => __( 'New APF Post', 'admin-page-framework-demo' ),
-    *               'view'               => __( 'View', 'admin-page-framework-demo' ),
-    *               'view_item'          => __( 'View APF Post', 'admin-page-framework-demo' ),
-    *               'search_items'       => __( 'Search APF Post', 'admin-page-framework-demo' ),
-    *               'not_found'          => __( 'No APF Post found', 'admin-page-framework-demo' ),
-    *               'not_found_in_trash' => __( 'No APF Post found in Trash', 'admin-page-framework-demo' ),
-    *               'parent'             => __( 'Parent APF Post', 'admin-page-framework-demo' ),
-    *               
-    *               // (framework specific)
-    *               'plugin_action_link' => __( 'APF Posts', 'admin-page-framework-demo' ), // framework specific key. [3.7.3+]
-    *           ),
-    *           'public'            => true,
-    *           'menu_position'     => 110,
-    *           'supports'          => array( 'title' ), // e.g. array( 'title', 'editor', 'comments', 'thumbnail', 'excerpt' ),    
-    *           'taxonomies'        => array( '' ),
-    *           'has_archive'       => true,
-    *           'show_admin_column' => true, // [3.5+ core] this is for custom taxonomies to automatically add the column in the listing table.
-    *           'menu_icon'         => $this->oProp->bIsAdmin 
-    *               ? ( 
-    *                   version_compare( $GLOBALS['wp_version'], '3.8', '>=' ) 
-    *                       ? 'dashicons-wordpress' 
-    *                       : plugins_url( 'asset/image/wp-logo_16x16.png', APFDEMO_FILE ) 
-    *               )
-    *               : null, // do not call the function in the front-end.
-    *               
-    *           // (framework specific) this sets the screen icon for the post type for WordPress v3.7.1 or below.
-    *           // a file path can be passed instead of a url, plugins_url( 'asset/image/wp-logo_32x32.png', APFDEMO_FILE )
-    *           'screen_icon' => dirname( APFDEMO_FILE  ) . '/asset/image/wp-logo_32x32.png', 
-    *           
-    *           // [3.5.10+] (framework specific) default: true
-    *           'show_submenu_add_new'  => true, 
-    *           
-    *           // [3.7.4+] (framework specific) default: 10
-    *           'submenu_order_manage'  => 20,
-    *           'submenu_order_addnew'  => 21,
-    * 
-    *       )     
-    * );</code>
-    * 
-    * <h4>Framework Specific Post Type Arguments</h4>
-    * In addition to the post type argument structure defined by the WordPress core, there are arguments defined by the framework.
-    * 
-    * - screen_icon - For WordPress 3.7.x or below, set an icon url or path for the 32x32 screen icon displayed in the post listing page.
-    * - show_submenu_add_new - [3.5.10+]    (boolean) Whether the sub-menu item of `Add New` should be displayed.
-    * - submenu_order_manage - [3.7.4+]     (numeric) The menu position of the `Manage` sub-menu item which gets automatically crated by the system when the admin ui is enabled. Default: `5`
-    * - submenu_order_addnew - [3.7.4+]     (numeric) The menu position of the `Manage` sub-menu item which gets automatically crated by the system when the admin ui is enabled. Default: `10`
-    *
-    * <h4>Framework Specific Post Type Label Arguments</h4>
-    * - plugin_listing_table_title_cell_link' - [3.0.6+] Deprecated [3.7.3] use the `plugin_action_link` argument instead.
-    * - plugin_action_link' - [3.7.3+] If the caller script is a plugin, this determines the label of the action link embedded in the plugin listing page (plugins.php).
-    * To disable the action link, set an empty string `''`. 
-
-    * 
-    * @since        2.0.0
-    * @since        2.1.6       Added the $sTextDomain parameter.
-    * @see          http://codex.wordpress.org/Function_Reference/register_post_type#Arguments
-    * @param        string      The post type slug.
-    * @param        array       The <a href="http://codex.wordpress.org/Function_Reference/register_post_type#Arguments">argument array</a> passed to register_post_type().
-    * @param        string      The path of the caller script. This is used to retrieve the script information to insert it into the footer. If not set, the framework tries to detect it.
-    * @param        string      The text domain of the caller script.
-    * @return       void
-    */
+     * The constructor of the class object.
+     * 
+     * Registers necessary hooks and sets up internal properties.
+     * 
+     * <h4>Example</h4>
+     * <code>new APF_PostType( 
+     *     'apf_posts',     // post type slug
+     *       array( 
+     *           'labels' => array(
+     *               'name'               => 'Demo',
+     *               'all_items'          => __( 'Sample Posts', 'admin-page-framework-demo' ),
+     *               'singular_name'      => 'Demo',
+     *               'add_new'            => __( 'Add New', 'admin-page-framework-demo' ),
+     *               'add_new_item'       => __( 'Add New APF Post', 'admin-page-framework-demo' ),
+     *               'edit'               => __( 'Edit', 'admin-page-framework-demo' ),
+     *               'edit_item'          => __( 'Edit APF Post', 'admin-page-framework-demo' ),
+     *               'new_item'           => __( 'New APF Post', 'admin-page-framework-demo' ),
+     *               'view'               => __( 'View', 'admin-page-framework-demo' ),
+     *               'view_item'          => __( 'View APF Post', 'admin-page-framework-demo' ),
+     *               'search_items'       => __( 'Search APF Post', 'admin-page-framework-demo' ),
+     *               'not_found'          => __( 'No APF Post found', 'admin-page-framework-demo' ),
+     *               'not_found_in_trash' => __( 'No APF Post found in Trash', 'admin-page-framework-demo' ),
+     *               'parent'             => __( 'Parent APF Post', 'admin-page-framework-demo' ),
+     *               
+     *               // (framework specific)
+     *               'plugin_action_link' => __( 'APF Posts', 'admin-page-framework-demo' ), // framework specific key. [3.7.3+]
+     *           ),
+     *           'public'            => true,
+     *           'menu_position'     => 110,
+     *           'supports'          => array( 'title' ), // e.g. array( 'title', 'editor', 'comments', 'thumbnail', 'excerpt' ),    
+     *           'taxonomies'        => array( '' ),
+     *           'has_archive'       => true,
+     *           'show_admin_column' => true, // [3.5+ core] this is for custom taxonomies to automatically add the column in the listing table.
+     *           'menu_icon'         => $this->oProp->bIsAdmin 
+     *               ? ( 
+     *                   version_compare( $GLOBALS['wp_version'], '3.8', '>=' ) 
+     *                       ? 'dashicons-wordpress' 
+     *                       : plugins_url( 'asset/image/wp-logo_16x16.png', APFDEMO_FILE ) 
+     *               )
+     *               : null, // do not call the function in the front-end.
+     *               
+     *           // (framework specific) this sets the screen icon for the post type for WordPress v3.7.1 or below.
+     *           // a file path can be passed instead of a url, plugins_url( 'asset/image/wp-logo_32x32.png', APFDEMO_FILE )
+     *           'screen_icon' => dirname( APFDEMO_FILE  ) . '/asset/image/wp-logo_32x32.png', 
+     *           
+     *           // [3.5.10+] (framework specific) default: true
+     *           'show_submenu_add_new'  => true, 
+     *           
+     *           // [3.7.4+] (framework specific) default: 10
+     *           'submenu_order_manage'  => 20,
+     *           'submenu_order_addnew'  => 21,
+     * 
+     *       )     
+     * );</code>
+     * 
+     * <h4>Framework Specific Post Type Arguments</h4>
+     * In addition to the post type argument structure defined by the WordPress core, there are arguments defined by the framework.
+     * 
+     * - screen_icon - For WordPress 3.7.x or below, set an icon url or path for the 32x32 screen icon displayed in the post listing page.
+     * - show_submenu_add_new - [3.5.10+]    (boolean) Whether the sub-menu item of `Add New` should be displayed.
+     * - submenu_order_manage - [3.7.4+]     (numeric) The menu position of the `Manage` sub-menu item which gets automatically crated by the system when the admin ui is enabled. Default: `5`
+     * - submenu_order_addnew - [3.7.4+]     (numeric) The menu position of the `Manage` sub-menu item which gets automatically crated by the system when the admin ui is enabled. Default: `10`
+     *
+     * <h4>Framework Specific Post Type Label Arguments</h4>
+     * - plugin_listing_table_title_cell_link' - [3.0.6+] Deprecated [3.7.3] use the `plugin_action_link` argument instead.
+     * - plugin_action_link' - [3.7.3+] If the caller script is a plugin, this determines the label of the action link embedded in the plugin listing page (plugins.php).
+     * To disable the action link, set an empty string `''`. 
+     * 
+     * @since        2.0.0
+     * @since        2.1.6       Added the $sTextDomain parameter.
+     * @see          http://codex.wordpress.org/Function_Reference/register_post_type#Arguments
+     * @param        string      The post type slug.
+     * @param        array       The <a href="http://codex.wordpress.org/Function_Reference/register_post_type#Arguments">argument array</a> passed to register_post_type().
+     * @param        string      The path of the caller script. This is used to retrieve the script information to insert it into the footer. If not set, the framework tries to detect it.
+     * @param        string      The text domain of the caller script.
+     * @return       void
+     */
     public function __construct( $sPostType, $aArguments=array(), $sCallerPath=null, $sTextDomain='admin-page-framework' ) {
         
         if ( empty( $sPostType ) ) {

Spacing +7 added lines, -7 removed lines

@@ -104,7 +104,7 @@ 
     * @param        string      The text domain of the caller script.
     * @return       void
     */
-    public function __construct( $sPostType, $aArguments=array(), $sCallerPath=null, $sTextDomain='admin-page-framework' ) {
+    public function __construct( $sPostType, $aArguments = array(), $sCallerPath = null, $sTextDomain = 'admin-page-framework' ) {
         
         if ( empty( $sPostType ) ) { 
             return; 
@@ -112,16 +112,16 @@ 
 
         $_sProprtyClassName = isset( $this->aSubClassNames[ 'oProp' ] )
             ? $this->aSubClassNames[ 'oProp' ]
-            : 'AdminPageFramework_Property_' . $this->_sStructureType;           
+            : 'AdminPageFramework_Property_'.$this->_sStructureType;           
         $this->oProp = new $_sProprtyClassName( 
             $this, 
             $this->_getCallerScriptPath( $sCallerPath ),
-            get_class( $this ),     // class name
-            'publish_posts',        // capability
-            $sTextDomain,           // text domain
+            get_class( $this ), // class name
+            'publish_posts', // capability
+            $sTextDomain, // text domain
             $this->_sStructureType  // structure type
         );
-        $this->oProp->sPostType     = AdminPageFramework_WPUtility::sanitizeSlug( $sPostType );
+        $this->oProp->sPostType = AdminPageFramework_WPUtility::sanitizeSlug( $sPostType );
         
         // Post type argument array structure
         // @see http://codex.wordpress.org/Function_Reference/register_post_type#Arguments
@@ -144,7 +144,7 @@ 
                 return $sCallerPath;
             }
             
-            if ( ! is_admin() ) {
+            if ( !is_admin() ) {
                 return null;
             }
             $_sPageNow = AdminPageFramework_Utility::getElement( $GLOBALS, 'pagenow' );

development/factory/post_type/AdminPageFramework_PostType_Controller.php

Braces +3 added lines, -3 removed lines

@@ -17,7 +17,7 @@ 
  * @package     AdminPageFramework
  * @subpackage  PostType
  */
-abstract class AdminPageFramework_PostType_Controller extends AdminPageFramework_PostType_View {    
+abstract class AdminPageFramework_PostType_Controller extends AdminPageFramework_PostType_View {
 
     /**
      * Sets up hooks and properties.
@@ -79,7 +79,7 @@ 
      * @since       3.0.0
      * @return      array       An array holding the handle IDs of queued items.
      */
-    public function enqueueStyles( $aSRCs, $aCustomArgs=array() ) {     
+    public function enqueueStyles( $aSRCs, $aCustomArgs=array() ) {
         if ( method_exists( $this->oResource, '_enqueueStyles' ) ) {
             return $this->oResource->_enqueueStyles( $aSRCs, array( $this->oProp->sPostType ), $aCustomArgs );
         }
@@ -114,7 +114,7 @@ 
      *  
      * @since       3.0.0
      */
-    public function enqueueScript( $sSRC, $aCustomArgs=array() ) {    
+    public function enqueueScript( $sSRC, $aCustomArgs=array() ) {
         if ( method_exists( $this->oResource, '_enqueueScript' ) ) {
             return $this->oResource->_enqueueScript( $sSRC, array( $this->oProp->sPostType ), $aCustomArgs );
         }

Indentation +79 added lines, -79 removed lines

@@ -20,37 +20,37 @@ 
 abstract class AdminPageFramework_PostType_Controller extends AdminPageFramework_PostType_View {    
 
     /**
-    * The method for necessary set-ups.
-    * 
-    * <h4>Example</h4>
-    * <code>public function setUp() {
-    *         $this->setAutoSave( false );
-    *         $this->setAuthorTableFilter( true );
-    *         $this->addTaxonomy( 
-    *             'sample_taxonomy', // taxonomy slug
-    *             array( // argument - for the argument array keys, refer to : http://codex.wordpress.org/Function_Reference/register_taxonomy#Arguments
-    *                 'labels'              => array(
-    *                     'name'            => 'Genre',
-    *                     'add_new_item'    => 'Add New Genre',
-    *                     'new_item_name'   => "New Genre"
-    *                 ),
-    *                 'show_ui'                 => true,
-    *                 'show_tagcloud'           => false,
-    *                 'hierarchical'            => true,
-    *                 'show_admin_column'       => true,
-    *                 'show_in_nav_menus'       => true,
-    *                 'show_table_filter'       => true, // framework specific key
-    *                 'show_in_sidebar_menus'   => false, // framework specific key
-    *             )
-    *         );
-    *     }</code>
-    * 
-    * @abstract
-    * @since        2.0.0
-    * @remark       The user should override this method in their class definition.
-    * @remark       A callback for the `wp_loaded` hook.
-    * @callback     action      init
-    */
+     * The method for necessary set-ups.
+     * 
+     * <h4>Example</h4>
+     * <code>public function setUp() {
+     *         $this->setAutoSave( false );
+     *         $this->setAuthorTableFilter( true );
+     *         $this->addTaxonomy( 
+     *             'sample_taxonomy', // taxonomy slug
+     *             array( // argument - for the argument array keys, refer to : http://codex.wordpress.org/Function_Reference/register_taxonomy#Arguments
+     *                 'labels'              => array(
+     *                     'name'            => 'Genre',
+     *                     'add_new_item'    => 'Add New Genre',
+     *                     'new_item_name'   => "New Genre"
+     *                 ),
+     *                 'show_ui'                 => true,
+     *                 'show_tagcloud'           => false,
+     *                 'hierarchical'            => true,
+     *                 'show_admin_column'       => true,
+     *                 'show_in_nav_menus'       => true,
+     *                 'show_table_filter'       => true, // framework specific key
+     *                 'show_in_sidebar_menus'   => false, // framework specific key
+     *             )
+     *         );
+     *     }</code>
+     * 
+     * @abstract
+     * @since        2.0.0
+     * @remark       The user should override this method in their class definition.
+     * @remark       A callback for the `wp_loaded` hook.
+     * @callback     action      init
+     */
     public function setUp() {}
     
     /**
@@ -116,49 +116,49 @@ 
      * Front-end methods
      */
     /**
-    * Enables or disables the auto-save feature in the custom post type's post submission page.
-    * 
-    * <h4>Example</h4>
-    * <code>$this->setAutoSave( false );
-    * </code>
-    * 
-    * @since        2.0.0
-    * @param        boolean         If true, it enables the auto-save; otherwise, it disables it.
-    * return        void
-    */ 
+     * Enables or disables the auto-save feature in the custom post type's post submission page.
+     * 
+     * <h4>Example</h4>
+     * <code>$this->setAutoSave( false );
+     * </code>
+     * 
+     * @since        2.0.0
+     * @param        boolean         If true, it enables the auto-save; otherwise, it disables it.
+     * return        void
+     */ 
     protected function setAutoSave( $bEnableAutoSave=True ) {
         $this->oProp->bEnableAutoSave = $bEnableAutoSave;     
     }
     
     /**
-    * Adds a custom taxonomy to the class post type.
-    * <h4>Example</h4>
-    * <code>$this->addTaxonomy( 
-    *   'sample_taxonomy', // taxonomy slug
-    *   array( // argument
-    *       'labels'        => array(
-    *       'name'          => 'Genre',
-    *       'add_new_item'  => 'Add New Genre',
-    *       'new_item_name' => "New Genre"
-    *   ),
-    *   'show_ui'               => true,
-    *   'show_tagcloud'         => false,
-    *   'hierarchical'          => true,
-    *   'show_admin_column'     => true,
-    *   'show_in_nav_menus'     => true,
-    *   'show_table_filter'     => true,  // framework specific key
-    *   'show_in_sidebar_menus' => false, // framework specific key
-    *   )
-    * );</code>
-    * 
-    * @see      http://codex.wordpress.org/Function_Reference/register_taxonomy#Arguments
-    * @since    2.0.0
-    * @since    3.1.1       Added the third parameter.
-    * @param    string      $sTaxonomySlug              The taxonomy slug.
-    * @param    array       $aArguments                      The taxonomy argument array passed to the second parameter of the <a href="http://codex.wordpress.org/Function_Reference/register_taxonomy#Arguments">register_taxonomy()</a> function.
-    * @param    array       $aAdditionalObjectTypes     Additional object types (post types) besides the caller post type.
-    * @return   void
-    */ 
+     * Adds a custom taxonomy to the class post type.
+     * <h4>Example</h4>
+     * <code>$this->addTaxonomy( 
+     *   'sample_taxonomy', // taxonomy slug
+     *   array( // argument
+     *       'labels'        => array(
+     *       'name'          => 'Genre',
+     *       'add_new_item'  => 'Add New Genre',
+     *       'new_item_name' => "New Genre"
+     *   ),
+     *   'show_ui'               => true,
+     *   'show_tagcloud'         => false,
+     *   'hierarchical'          => true,
+     *   'show_admin_column'     => true,
+     *   'show_in_nav_menus'     => true,
+     *   'show_table_filter'     => true,  // framework specific key
+     *   'show_in_sidebar_menus' => false, // framework specific key
+     *   )
+     * );</code>
+     * 
+     * @see      http://codex.wordpress.org/Function_Reference/register_taxonomy#Arguments
+     * @since    2.0.0
+     * @since    3.1.1       Added the third parameter.
+     * @param    string      $sTaxonomySlug              The taxonomy slug.
+     * @param    array       $aArguments                      The taxonomy argument array passed to the second parameter of the <a href="http://codex.wordpress.org/Function_Reference/register_taxonomy#Arguments">register_taxonomy()</a> function.
+     * @param    array       $aAdditionalObjectTypes     Additional object types (post types) besides the caller post type.
+     * @return   void
+     */ 
     protected function addTaxonomy( $sTaxonomySlug, array $aArguments, array $aAdditionalObjectTypes=array() ) {
 
         $sTaxonomySlug  = $this->oUtil->sanitizeSlug( $sTaxonomySlug );
@@ -220,16 +220,16 @@ 
         }
 
     /**
-    * Sets whether the author drop-down filter is enabled/disabled in the post type post list table.
-    * 
-    * <h4>Example</h4>
-    * <code>$this->setAuthorTableFilter( true );
-    * </code>
-    * 
-    * @since        2.0.0
-    * @param        boolean     $bEnableAuthorTableFileter      If true, it enables the author filter; otherwise, it disables it.
-    * @return       void
-    */ 
+     * Sets whether the author drop-down filter is enabled/disabled in the post type post list table.
+     * 
+     * <h4>Example</h4>
+     * <code>$this->setAuthorTableFilter( true );
+     * </code>
+     * 
+     * @since        2.0.0
+     * @param        boolean     $bEnableAuthorTableFileter      If true, it enables the author filter; otherwise, it disables it.
+     * @return       void
+     */ 
     protected function setAuthorTableFilter( $bEnableAuthorTableFileter=false ) {
         $this->oProp->bEnableAuthorTableFileter = $bEnableAuthorTableFileter;
     }

Spacing +12 added lines, -12 removed lines

@@ -71,7 +71,7 @@ 
      * @since       3.0.0
      * @return      array       An array holding the handle IDs of queued items.
      */
-    public function enqueueStyles( $aSRCs, $aCustomArgs=array() ) {     
+    public function enqueueStyles( $aSRCs, $aCustomArgs = array() ) {     
         if ( method_exists( $this->oResource, '_enqueueStyles' ) ) {
             return $this->oResource->_enqueueStyles( $aSRCs, array( $this->oProp->sPostType ), $aCustomArgs );
         }
@@ -82,7 +82,7 @@ 
      * {@inheritdoc}
      * 
      */    
-    public function enqueueStyle( $sSRC, $aCustomArgs=array() ) {
+    public function enqueueStyle( $sSRC, $aCustomArgs = array() ) {
         if ( method_exists( $this->oResource, '_enqueueStyle' ) ) {
             return $this->oResource->_enqueueStyle( $sSRC, array( $this->oProp->sPostType ), $aCustomArgs );     
         }
@@ -94,7 +94,7 @@ 
      * 
      * @return      array       An array holding the handle IDs of queued items.
      */
-    public function enqueueScripts( $aSRCs, $aCustomArgs=array() ) {
+    public function enqueueScripts( $aSRCs, $aCustomArgs = array() ) {
         if ( method_exists( $this->oResource, '_enqueueScripts' ) ) {
             return $this->oResource->_enqueueScripts( $aSRCs, array( $this->oProp->sPostType ), $aCustomArgs );
         }
@@ -106,7 +106,7 @@ 
      *  
      * @since       3.0.0
      */
-    public function enqueueScript( $sSRC, $aCustomArgs=array() ) {    
+    public function enqueueScript( $sSRC, $aCustomArgs = array() ) {    
         if ( method_exists( $this->oResource, '_enqueueScript' ) ) {
             return $this->oResource->_enqueueScript( $sSRC, array( $this->oProp->sPostType ), $aCustomArgs );
         }
@@ -126,7 +126,7 @@ 
     * @param        boolean         If true, it enables the auto-save; otherwise, it disables it.
     * return        void
     */ 
-    protected function setAutoSave( $bEnableAutoSave=True ) {
+    protected function setAutoSave( $bEnableAutoSave = True ) {
         $this->oProp->bEnableAutoSave = $bEnableAutoSave;     
     }
     
@@ -159,20 +159,20 @@ 
     * @param    array       $aAdditionalObjectTypes     Additional object types (post types) besides the caller post type.
     * @return   void
     */ 
-    protected function addTaxonomy( $sTaxonomySlug, array $aArguments, array $aAdditionalObjectTypes=array() ) {
+    protected function addTaxonomy( $sTaxonomySlug, array $aArguments, array $aAdditionalObjectTypes = array() ) {
 
         $sTaxonomySlug  = $this->oUtil->sanitizeSlug( $sTaxonomySlug );
         $aArguments     = $aArguments + array(
             'show_table_filter'     => null,
             'show_in_sidebar_menus' => null,
-            'submenu_order'         => 15,  // 3.7.4
-        ) ;
+            'submenu_order'         => 15, // 3.7.4
+        );
         $this->oProp->aTaxonomies[ $sTaxonomySlug ] = $aArguments;
         
         if ( $aArguments[ 'show_table_filter' ] ) {
-            $this->oProp->aTaxonomyTableFilters[] = $sTaxonomySlug;
+            $this->oProp->aTaxonomyTableFilters[ ] = $sTaxonomySlug;
         }
-        if ( ! $aArguments[ 'show_in_sidebar_menus' ] ) {
+        if ( !$aArguments[ 'show_in_sidebar_menus' ] ) {
             // @todo investigate the best handling method of taxonomy sub-menu items of a custom post type added to another custom post type menu with the `show_in_menu` arugment.
             $this->oProp->aTaxonomyRemoveSubmenuPages[ "edit-tags.php?taxonomy={$sTaxonomySlug}&post_type={$this->oProp->sPostType}" ] = "edit.php?post_type={$this->oProp->sPostType}";
         }
@@ -230,7 +230,7 @@ 
     * @param        boolean     $bEnableAuthorTableFileter      If true, it enables the author filter; otherwise, it disables it.
     * @return       void
     */ 
-    protected function setAuthorTableFilter( $bEnableAuthorTableFileter=false ) {
+    protected function setAuthorTableFilter( $bEnableAuthorTableFileter = false ) {
         $this->oProp->bEnableAuthorTableFileter = $bEnableAuthorTableFileter;
     }
     
@@ -255,7 +255,7 @@ 
      * @param       array       $aArguments     The <a href="http://codex.wordpress.org/Function_Reference/register_post_type#Arguments">array of arguments</a> to be passed to the second parameter of the `register_post_type()` function.
      * @since       3.2.0
      */
-    protected function setArguments( array $aArguments=array() ) {
+    protected function setArguments( array $aArguments = array() ) {
         $this->oProp->aPostTypeArgs = $aArguments;
     }