AdminPageFramework_Form_View__Resource

Complexity

Total Complexity

38

Size/Duplication

Total Lines	320
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	2
B	_setHooks()	0	29	4
B	_setAdminHooks()	0	26	3
A	_replyToInsertRequiredInlineScripts()	0	15	2
A	_getScripts_RequiredInHead()	0	5	1
A	_getInlineCSS()	0	5	1
A	_getScriptElementConcealerCSSRules()	0	3	1
A	_replyToEnqueueScripts()	0	8	3
B	_enqueueScript()	0	28	4
A	_getFormattedEnqueueScript()	0	17	2
A	_replyToEnqueueStyles()	0	10	3
A	_enqueueStyle()	0	10	1
A	_getFormattedEnqueueStyle()	0	16	2
B	_replyToAddStyle()	0	29	4
A	_getFormattedInlineStyles()	0	6	2
A	_replyToAddScript()	0	18	3

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

/**
 * Provides methods to build forms.
 * 
 * This is a delegation class of `AdminPageFramework_Form_View`.
 * 
 * @package     AdminPageFramework
 * @subpackage  Form
 * @since       DEVVER
 */
class AdminPageFramework_Form_View__Resource extends AdminPageFramework_WPUtility {

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

As per PSR2, the opening brace for this class should be on a new line.

    
    /**
     * Stores the form object to let this class access the resource array.
     */
    public $oForm;
    
    /**
     * Sets up hooks.
     * @since       DEVVER
     */
    public function __construct( $oForm ) {

        $this->oForm = $oForm;
    
        // If it is loaded in the background, no need to load scripts and styles.
        if ( $this->isDoingAjax() ) {
            return;
        }    
    
        $this->_setHooks();
  
    }
    
        /**
         * @since       DEVVER
         */
        private function _setHooks() {

Method name "_setHooks" should not be prefixed with an underscore to indicate visibility

            
            if ( is_admin() ) {
                $this->_setAdminHooks();
                return;
            }
            
            // Hook the admin header to insert custom admin stylesheets and scripts.
            add_action( 'wp_enqueue_scripts', array( $this, '_replyToEnqueueScripts' ) );
            add_action( 'wp_enqueue_scripts', array( $this, '_replyToEnqueueStyles' ) );
            
            /// A low priority is required to let dependencies loaded fast especially in customizer.php.
            add_action( did_action( 'wp_print_styles' ) ? 'wp_print_footer_scripts' : 'wp_print_styles', array( $this, '_replyToAddStyle' ), 999 );
            add_action( did_action( 'wp_print_scripts' ) ? 'wp_print_footer_scripts' : 'wp_print_scripts', array( $this, '_replyToAddScript' ), 999 );     
        
            // Take care of items that could not be added in the head tag.
            
            /// For admin pages other than wp-admin/customizer.php 
            add_action( 'wp_footer', array( $this, '_replyToEnqueueScripts' ) ); 
            add_action( 'wp_footer', array( $this, '_replyToEnqueueStyles' ) );        
            
            /// For all admin pages.
            add_action( 'wp_print_footer_scripts', array( $this, '_replyToAddStyle' ), 999 );
            add_action( 'wp_print_footer_scripts', array( $this, '_replyToAddScript' ), 999 );
                        
            // Required scripts in the head tag.
            add_action( 'wp_head', array( $this, '_replyToInsertRequiredInlineScripts' ) );
                      
        }
            private function _setAdminHooks() {

Method name "_setAdminHooks" should not be prefixed with an underscore to indicate visibility

                
                // Hook the admin header to insert custom admin stylesheets and scripts.
                add_action( 'admin_enqueue_scripts', array( $this, '_replyToEnqueueScripts' ) );
                add_action( 'admin_enqueue_scripts', array( $this, '_replyToEnqueueStyles' ) );
        
                add_action( did_action( 'admin_print_styles' ) ? 'admin_print_footer_scripts' : 'admin_print_styles', array( $this, '_replyToAddStyle' ), 999 );
                add_action( did_action( 'admin_print_scripts' ) ? 'admin_print_footer_scripts' : 'admin_print_scripts', array( $this, '_replyToAddScript' ), 999 );                         
                    
                // Take care of items that could not be added in the head tag.                
                /// For wp-admin/customizer.php 
                add_action( 'customize_controls_print_footer_scripts', array( $this, '_replyToEnqueueScripts' ) );
                add_action( 'customize_controls_print_footer_scripts', array( $this, '_replyToEnqueueStyles' ) );

                /// For admin pages other than wp-admin/customizer.php 
                add_action( 'admin_footer', array( $this, '_replyToEnqueueScripts' ) ); 
                add_action( 'admin_footer', array( $this, '_replyToEnqueueStyles' ) );        
                
                /// For all admin pages.
                add_action( 'admin_print_footer_scripts', array( $this, '_replyToAddStyle' ), 999 );
                add_action( 'admin_print_footer_scripts', array( $this, '_replyToAddScript' ), 999 );  
                               
                // Required scripts in the head tag.
                add_action( 'admin_head', array( $this, '_replyToInsertRequiredInlineScripts' ) );
                
            }
    /**
     * Inserts JavaScript scripts whihc must be inserted head.
     * @since       DEVVER
     * @return      string
     */
    public function _replyToInsertRequiredInlineScripts() {

Method name "_replyToInsertRequiredInlineScripts" should not be prefixed with an underscore to indicate visibility

        
        // Ensure to load only once per page load
        if ( self::$_bLoaded ) {
            return;
        }
        self::$_bLoaded = true;                
        
        echo "<script type='text/javascript' class='admin-page-framework-form-script-required-in-head'>" 
                . '/* <![CDATA[ */'
                . $this->_getScripts_RequiredInHead()
                . '/* ]]> */'
            . "</script>";  
            
    }
        static private $_bLoaded = false;

Please declare explicit visibility instead of using a prefixed underscore.

        
        /**
         * @since       DEVVER
         * @return      string
         */
        private function _getScripts_RequiredInHead() {

Method name "_getScripts_RequiredInHead" should not be prefixed with an underscore to indicate visibility

            return 'document.write( "<style class=\'admin-page-framework-js-embedded-inline-style\'>'
                    . esc_js( $this->_getInlineCSS() )
                . '</style>" );';            
        }
            /**
             * @return      string
             * @since       DEVVER
             */
            private function _getInlineCSS() {

Method name "_getInlineCSS" should not be prefixed with an underscore to indicate visibility

                $_oLoadingCSS = new AdminPageFramework_Form_View___CSS_Loading;
                $_oLoadingCSS->add( $this->_getScriptElementConcealerCSSRules() );
                return $_oLoadingCSS->get();
            }
                /**
                 * Hides the form initially to prevent unformatted layouts being displayed during document load. 
                 * @remark      Use visibility to reserve the element area in the screen.
                 * @return      string
                 * @since       DEVVER
                 */
                private function _getScriptElementConcealerCSSRules() {                    

Method name "_getScriptElementConcealerCSSRules" should not be prefixed with an underscore to indicate visibility

                    return ".admin-page-framework-form-js-on { visibility: hidden; }";
                }

    /**
     * Enqueues page script resources.
     * 
     * @since       DEVVER
     */
    public function _replyToEnqueueScripts() {

Method name "_replyToEnqueueScripts" should not be prefixed with an underscore to indicate visibility

        if ( ! $this->oForm->isInThePage() ) {
            return;
        }
        foreach( $this->oForm->getResources( 'src_scripts' ) as $_asEnqueue ) {
            $this->_enqueueScript( $_asEnqueue );
        }       
    }
        /**
         * Stores flags of enqueued items.
         * @since       DEVVER
         */
        static private $_aEnqueued = array();    

Please declare explicit visibility instead of using a prefixed underscore.

        /**
         * @return      void
         * @since       DEVVER
         */
        private function _enqueueScript( $asEnqueue ) {

Method name "_enqueueScript" should not be prefixed with an underscore to indicate visibility

                
            $_aEnqueueItem = $this->_getFormattedEnqueueScript( $asEnqueue );
            
            // Do not load the same items multiple times.
            if ( isset( self::$_aEnqueued[ $_aEnqueueItem[ 'src' ] ] ) ) {
                return;
            }
            self::$_aEnqueued[ $_aEnqueueItem[ 'src' ] ] = $_aEnqueueItem;
            
            wp_enqueue_script( 
                $_aEnqueueItem[ 'handle_id' ], 
                $_aEnqueueItem[ 'src' ], 
                $_aEnqueueItem[ 'dependencies' ], 
                $_aEnqueueItem[ 'version' ], 
                did_action( 'admin_body_class' ) 
                    ? true 
                    : $_aEnqueueItem[ 'in_footer' ]
            );
            if ( $_aEnqueueItem[ 'translation' ] ) {
                wp_localize_script( 
                    $_aEnqueueItem[ 'handle_id' ], 
                    $_aEnqueueItem[ 'handle_id' ], 
                    $_aEnqueueItem[ 'translation' ] 
                );
            }                
            
        }            
            /**
             * @return      array
             * @since       DEVVER
             */
            private function _getFormattedEnqueueScript( $asEnqueue ) {

Method name "_getFormattedEnqueueScript" should not be prefixed with an underscore to indicate visibility

                static $_iCallCount = 1;
                $_aEnqueueItem = $this->getAsArray( $asEnqueue ) + array(
                    'handle_id'     => 'script_' . $this->oForm->aArguments[ 'caller_id' ] . '_' . $_iCallCount,
                    'src'           => null,
                    'dependencies'  => null,
                    'version'       => null,
                    'in_footer'     => false,
                    'translation'   => null,
                );
                if ( is_string( $asEnqueue ) ) {
                    $_aEnqueueItem[ 'src' ] = $asEnqueue;
                }                 
                $_aEnqueueItem[ 'src' ] = $this->getResolvedSRC( $_aEnqueueItem[ 'src' ] );
                $_iCallCount++;
                return $_aEnqueueItem;
            }    

    
    /**
     * Enqueues page stylesheet resources.
     * 
     * @since       DEVVER
     */    
    public function _replyToEnqueueStyles() {

Method name "_replyToEnqueueStyles" should not be prefixed with an underscore to indicate visibility

        if ( ! $this->oForm->isInThePage() ) {
            return;
        }
        foreach( $this->oForm->getResources( 'src_styles' ) as $_asEnqueueItem ) {
            $this->_enqueueStyle( $_asEnqueueItem );
        }           
    
    }
        private function _enqueueStyle( $asEnqueue ) {

Method name "_enqueueStyle" should not be prefixed with an underscore to indicate visibility

            $_aEnqueueItem = $this->_getFormattedEnqueueStyle( $asEnqueue );
            wp_enqueue_style( 
                $_aEnqueueItem[ 'handle_id' ],
                $_aEnqueueItem[ 'src' ], 
                $_aEnqueueItem[ 'dependencies' ], 
                $_aEnqueueItem[ 'version' ], 
                $_aEnqueueItem[ 'media' ]
            );            
        }
            /**
             * @return      array
             */
            private function _getFormattedEnqueueStyle( $asEnqueue ) {

Method name "_getFormattedEnqueueStyle" should not be prefixed with an underscore to indicate visibility

                static $_iCallCount = 1;
                $_aEnqueueItem = $this->getAsArray( $asEnqueue ) + array(
                    'handle_id'     => 'style_' . $this->oForm->aArguments[ 'caller_id' ] . '_' . $_iCallCount,
                    'src'           => null,
                    'dependencies'  => null,
                    'version'       => null,
                    'media'         => null,
                );
                if ( is_string( $asEnqueue ) ) {
                    $_aEnqueueItem[ 'src' ] = $asEnqueue;
                }                 
                $_aEnqueueItem[ 'src' ] = $this->getResolvedSRC( $_aEnqueueItem[ 'src' ] );
                $_iCallCount++;
                return $_aEnqueueItem;
            }            
    
    /**
     * Enqueues inline styles.
     * 
     * @since       DEVVER
     */    
    public function _replyToAddStyle() {

Method name "_replyToAddStyle" should not be prefixed with an underscore to indicate visibility

        
        if ( ! $this->oForm->isInThePage() ) {
            return;
        }   
        $_sCSSRules = $this->_getFormattedInlineStyles( 
            $this->oForm->getResources( 'inline_styles' )
        );
        
        $_sID = $this->sanitizeSlug( strtolower( $this->oForm->aArguments[ 'caller_id' ] ) );
        if ( $_sCSSRules ) {            
            echo "<style type='text/css' id='inline-style-{$_sID}' class='admin-page-framework-form-style'>"
                    . $_sCSSRules
                . "</style>";
        }        
        $_sIECSSRules = $this->_getFormattedInlineStyles( 
            $this->oForm->getResources( 'inline_styles_ie' )
        );        
        if ( $_sIECSSRules ) {
            echo "<!--[if IE]><style type='text/css' id='inline-style-ie-{$_sID}' class='admin-page-framework-form-ie-style'>"
                    . $_sIECSSRules
                . "</style><![endif]-->";
        } 
        
        // Empty the values as this method can be called multiple times, in the head tag and the footer.
        $this->oForm->setResources( 'inline_styles', array() );
        $this->oForm->setResources( 'inline_styles_ie', array() );
        
    }
        /**
         * @since       DEVVER
         * @string
         */
        private function _getFormattedInlineStyles( array $aInlineStyles ) {

Method name "_getFormattedInlineStyles" should not be prefixed with an underscore to indicate visibility

            $_sCSSRules = implode( PHP_EOL, array_unique( $aInlineStyles ) );
            return $this->isDebugMode()
                ? $_sCSSRules
                : $this->minifyCSS( $_sCSSRules );
        }
    
    /**
     * Enqueues page inline scripts.
     * 
     * @since       DEVVER
     */    
    public function _replyToAddScript() {

Method name "_replyToAddScript" should not be prefixed with an underscore to indicate visibility

        
        if ( ! $this->oForm->isInThePage() ) {
            return;
        }        
        
        $_sScript = implode( PHP_EOL, array_unique( $this->oForm->getResources( 'inline_scripts' ) ) );
        if ( $_sScript ) {
            $_sID = $this->sanitizeSlug( strtolower( $this->oForm->aArguments[ 'caller_id' ] ) );
            echo "<script type='text/javascript' id='inline-script-{$_sID}' class='admin-page-framework-form-script'>" 
                    . '/* <![CDATA[ */'
                    . $_sScript
                    . '/* ]]> */'
                . "</script>"; 
        }        
        $this->oForm->setResources( 'inline_scripts', array() );
        
    }
   
}

According to PSR2, the closing brace of classes should be placed on the next line directly after the body.