AdminPageFramework_Format_InPageTab

Complexity

Total Complexity

4

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	1
A	get()	0	10	1
A	_getPageShowDebugInfo()	0	7	1
A	_getPageCapability()	0	7	1

<?php
/**
 * Admin Page Framework
 * 
 * http://en.michaeluno.jp/admin-page-framework/
 * Copyright (c) 2013-2016 Michael Uno; Licensed MIT
 * 
 */

/**
 * Provides methods to format form in-page tabs definition arrays.
 * 
 * @package     AdminPageFramework
 * @subpackage  Factory/AdminPage/Format
 * @since       3.6.0
 * @internal
 */
class AdminPageFramework_Format_InPageTab extends AdminPageFramework_Format_Base {
    
    /**
     * Represents the structure of the sub-field definition array.
     * @since       2.0.0
     * @since       3.3.1       Moved from `AdminPageFramework_Page`.
     * @since       3.6.0       Moved from `AdminPageFramework_Page_Model`.
     * @var         array
     * @static
     * @access      private
     * @internal
     */
    static public $aStructure = array(
        'page_slug'         => null,
        'tab_slug'          => null,
        'title'             => null,
        'order'             => 10,      // (integer)
        'show_in_page_tab'  => true,    // 3.6.0+ (boolean)
        'parent_tab_slug'   => null,    // this needs to be set if the above show_in_page_tab is false so that the framework can mark the parent tab to be active when the hidden page is accessed.
        'url'               => null,    // 3.5.0+ This allows the user set custom link.
        'disabled'          => null,    // 3.5.10+ (boolean) If true, the link will be unlinked.
        'attributes'        => null,    // 3.5.10+ (array) Applies to the navigation tab bar element.    
        'capability'        => null,    // 3.6.0+ (string)
        'if'                => true,    // 3.6.0+ (boolean)
        'show_debug_info'   => null,    // 3.8.8+ (boolean, optional) Whether to show debug information. If not set, the existent `bShowDebugInfo` property value will be used. The initial value here is `null` as the default value will be assigned in the formatting method.
    );
    
    /**
     * Stores an in-page tab definition.
     */
    public $aInPageTab = array();
    
    public $sPageSlug = '';
    
    public $oFactory;
    
    /**
     * Sets up properties
     */
    public function __construct( /* $aInPageTab, $sPageSlug, $oFactory */ ) {
     
        $_aParameters = func_get_args() + array( 
            $this->aInPageTab, 
            $this->sPageSlug, 
            $this->oFactory, 
        );
        $this->aInPageTab  = $_aParameters[ 0 ];

It seems like $_aParameters[0] of type * is incompatible with the declared type array of property $aInPageTab.

        $this->sPageSlug   = $_aParameters[ 1 ];
        $this->oFactory    = $_aParameters[ 2 ];
     
    }

    /**
     * 
     * @return      array       A sub-fields definition array.
     */
    public function get() {

        return array(
            'page_slug'         => $this->sPageSlug,
        ) + $this->aInPageTab + array(
            'capability'        => $this->_getPageCapability(),        
            'show_debug_info'   => $this->_getPageShowDebugInfo(),
        ) + self::$aStructure;
        
    }
        /**
         * Retrieves the `show_debug_info` argument value of the page that this tab belongs to.
         * 
         * @remark      This is to inherit the value of the page that the tab belongs to.
         * @internal
         * @return      boolean
         * @since       3.8.8
         */
        private function _getPageShowDebugInfo() {
            return $this->getElement(
                $this->oFactory->oProp->aPages,
                array( $this->sPageSlug, 'show_debug_info' ),
                $this->oFactory->oProp->bShowDebugInfo
            );      
        }        
        /**
         * Retrieves the capability of the page that the subject tab belongs to.
         * 
         * @remark      This is to inherit the value of the page that the tab belongs to.
         * @return      string
         * @since       3.6.0
         */
        private function _getPageCapability() {
            return $this->getElement(
                $this->oFactory->oProp->aPages,
                array( $this->sPageSlug, 'capability' ),
                $this->oFactory->oProp->sCapability
            );      
        }
        
}