AdminPageFramework_Form_View__Resource

Complexity

Total Complexity

50

Size/Duplication

Total Lines	405
Duplicated Lines	0 %

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	___registerStyle()	0	12	1
A	_replyToEnqueueStyles()	0	12	4
A	___enqueueStyle()	0	15	3
A	___getFormattedEnqueueScript()	0	18	2
A	___registerScript()	0	20	4
A	__construct()	0	16	3
A	___setHooks()	0	27	3
A	_replyToAddScript()	0	17	3
A	___getFormattedEnqueueStyle()	0	16	2
A	_replyToEnqueueScripts()	0	11	4
A	___getFormattedInternalStyles()	0	2	1
A	___setAdminHooks()	0	24	2
A	_replyToAddStyle()	0	27	4
B	___getSRCFormatted()	0	41	7
B	___enqueueScript()	0	30	7

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

/**
 * Provides methods to build forms.
 *
 * This is a delegation class of `AdminPageFramework_Form_View`.
 *
 * @package     AdminPageFramework/Common/Form/View/Resource
 * @since       3.7.0
 * @extends     AdminPageFramework_FrameworkUtility
 * @internal
 */
class AdminPageFramework_Form_View__Resource extends AdminPageFramework_FrameworkUtility {

    /**
     * Stores the form object to let this class access the resource array.
     * @var AdminPageFramework_Form
     */
    public $oForm;

    /**
     * Sets up hooks.
     * @since       3.7.0
     */
    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;
        }

        // Widgets can be called multiple times for the number of user-created widget instances for one class instance
        // so make sure it is processed only once per page.
        if ( $this->hasBeenCalled( 'resource_' . $oForm->aArguments[ 'caller_id' ] ) ) {
             return;
        }

        $this->___setHooks();

    }

        /**
         * @since       3.7.0
         */
        private function ___setHooks() {

            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 ); // @deprecated 3.8.11 All the added scripts should be loaded in the footer.

            // 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.
            new AdminPageFramework_Form_View__Resource__Head( $this->oForm, 'wp_head' );

        }
            private function ___setAdminHooks() {

                // 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 ); // @deprecated 3.8.11 All the added scripts should be loaded in the footer.

                // 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.
                new AdminPageFramework_Form_View__Resource__Head( $this->oForm, 'admin_head' );

            }

    /**
     * Enqueues page script resources.
     *
     * @since       3.7.0
     */
    public function _replyToEnqueueScripts() {
        if ( ! $this->oForm->isInThePage() ) {
            return;
        }
        $_aRegister = $this->oForm->getResources( 'register' );
        foreach( $this->getElementAsArray( $_aRegister, array( 'scripts' ) ) as $_iIndex => $_aRegister ) {
            $this->___registerScript( $_aRegister );
        }
        foreach( $this->oForm->getResources( 'src_scripts' ) as $_isIndex => $_asEnqueue ) {
            $this->___enqueueScript( $_asEnqueue );
            $this->oForm->unsetResources( array( 'src_scripts', $_isIndex ) );  // no longer needed
        }
    }
        /**
         * @param array $aRegister
         * @since 3.9.0
        */
        private function ___registerScript( array $aRegister ) {

            $aRegister = $aRegister + array(
                'handle_id'     => '',          'src'       => '',
                'dependencies'  => array(),     'version'   => false,
                'in_footer'     => false,
                'translation'   => array(),     'translation_var'   => '',
            );
            $_bRegistered = wp_register_script(
                $aRegister[ 'handle_id' ],
                $this->___getSRCFormatted( $aRegister ),
                $aRegister[ 'dependencies' ],
                $aRegister[ 'version' ],
                $aRegister[ 'in_footer' ]
            );
            if ( $_bRegistered && ! empty( $aRegister[ 'translation' ] ) ) {
                wp_localize_script(
                    $aRegister[ 'handle_id' ],
                    $aRegister[ 'translation_var' ] ? $aRegister[ 'translation_var' ] : $aRegister[ 'translation_var' ],
                    $this->getAsArray( $aRegister[ 'translation' ] )
                );
            }

        }
        /**
         * Stores flags of enqueued items.
         * @since       3.7.0
         */
        static private $_aEnqueued = array();
        /**
         * @return      void
         * @since       3.7.0
         */
        private function ___enqueueScript( $asEnqueue ) {

            $_sSetHandleID = $this->getElement( $this->getAsArray( $asEnqueue ), 'handle_id', '' );
            $_aEnqueueItem = $this->___getFormattedEnqueueScript( $asEnqueue );
            $_sCacheID     = $_sSetHandleID . $this->getElement( $_aEnqueueItem, 'src', '' );

            // Do not load the same items multiple times.
            // Checking if src is not empty is because there is a case that src is empty to just use handle ID to enqueue an item
            // Allow same SRCs as field types extends another field type and script can have the same resource but with a different handle ID and translations.
            if ( ! empty( $_sCacheID ) && isset( self::$_aEnqueued[ $_sCacheID ] ) ) {
                return;
            }
            self::$_aEnqueued[ $_sCacheID ] = $_aEnqueueItem;

            wp_enqueue_script(
                $_aEnqueueItem[ 'handle_id' ],
                $_aEnqueueItem[ 'src' ],
                $_aEnqueueItem[ 'dependencies' ],
                $_aEnqueueItem[ 'version' ],
                did_action( 'admin_body_class' ) || ( boolean ) $_aEnqueueItem[ 'in_footer' ]
            );
            if ( $_aEnqueueItem[ 'translation' ] ) {
                wp_localize_script(
                    $_aEnqueueItem[ 'handle_id' ],
                    empty( $_aEnqueueItem[ 'translation_var' ] ) ? $_aEnqueueItem[ 'handle_id' ] : $_aEnqueueItem[ 'translation_var' ],
                    $_aEnqueueItem[ 'translation' ]
                );
            }
            if ( $_aEnqueueItem[ 'conditional' ] ) {
                wp_script_add_data( $_aEnqueueItem[ 'handle_id' ], 'conditional', $_aEnqueueItem[ 'conditional' ] );
            }

        }
            /**
             * @return      array
             * @since       3.7.0
             */
            private function ___getFormattedEnqueueScript( $asEnqueue ) {
                static $_iCallCount = 1;
                $_aEnqueueItem = $this->getAsArray( $asEnqueue ) + array(
                    'handle_id'         => 'admin-page-framework-script-form-' . $this->oForm->aArguments[ 'caller_id' ] . '_' . $_iCallCount,
                    'src'               => null,
                    'dependencies'      => null,
                    'version'           => null,
                    'in_footer'         => false,
                    'translation'       => null,
                    'conditional'       => null,
                    'translation_var'   => null,
                );
                if ( is_string( $asEnqueue ) ) {
                    $_aEnqueueItem[ 'src' ] = $asEnqueue;
                }
                $_aEnqueueItem[ 'src' ] = $this->___getSRCFormatted( $_aEnqueueItem );
                $_iCallCount++;
                return $_aEnqueueItem;
            }


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

        if ( ! $this->oForm->isInThePage() ) {
            return;
        }
        $_aRegister = $this->oForm->getResources( 'register' );
        foreach( $this->getElementAsArray( $_aRegister, array( 'styles' ) ) as $_iIndex => $_aRegister ) {
            $this->___registerStyle( $_aRegister );
        }
        foreach( $this->oForm->getResources( 'src_styles' ) as $_isIndex => $_asEnqueueItem ) {
            $this->___enqueueStyle( $_asEnqueueItem );
            $this->oForm->unsetResources( array( 'src_styles', $_isIndex ) ); // no longer needed
        }

    }
        /**
         * @param array $aRegister
         * @since 3.9.0
         */
        private function ___registerStyle( array $aRegister ) {
            $_aRegister = $aRegister + array(
                'handle_id'     => null,     'src'           => null,
                'dependencies'  => array(),  'version'       => false,
                'media'         => 'all',
            );
            wp_register_style(
                $_aRegister[ 'handle_id' ],
                $this->___getSRCFormatted( $_aRegister ),
                $_aRegister[ 'dependencies' ],
                $_aRegister[ 'version' ],
                $_aRegister[ 'media' ]
            );
        }
        /**
         * @param array|string $asEnqueue
         * @since 3.9.0
         */
        private function ___enqueueStyle( $asEnqueue ) {
            $_aEnqueueItem = $this->___getFormattedEnqueueStyle( $asEnqueue );
            wp_enqueue_style(
                $_aEnqueueItem[ 'handle_id' ],
                $_aEnqueueItem[ 'src' ],
                $_aEnqueueItem[ 'dependencies' ],
                $_aEnqueueItem[ 'version' ],
                $_aEnqueueItem[ 'media' ]
            );
            $_aAddData = array( 'conditional', 'rtl', 'suffix', 'alt', 'title' );
            foreach( $_aAddData as $_sDataKey ) {
                if ( ! isset( $aEnqueueItem[ $_sDataKey ] ) ) {

The variable $aEnqueueItem does not exist. Did you maybe mean $_aEnqueueItem?

                    continue;
                }
                wp_style_add_data( $aEnqueueItem[ 'handle_id' ], $_sDataKey, $aEnqueueItem[ $_sDataKey ] );
            }
        }
            /**
             * @return      array
             */
            private function ___getFormattedEnqueueStyle( $asEnqueue ) {
                static $_iCallCount = 1;
                $_aEnqueueItem = $this->getAsArray( $asEnqueue ) + array(
                    'handle_id'     => 'admin-page-framework-style-form-' . $this->oForm->aArguments[ 'caller_id' ] . '_' . $_iCallCount,
                    'src'           => null,    'dependencies'  => null,
                    'version'       => null,    'media'         => null,
                    'conditional'   => null,
                    'rtl'           => null,    'suffix'        => null,
                    'alt'           => null,    'title'         => null,
                );
                if ( is_string( $asEnqueue ) ) {
                    $_aEnqueueItem[ 'src' ] = $asEnqueue;
                }
                $_aEnqueueItem[ 'src' ] = $this->___getSRCFormatted( $_aEnqueueItem );
                $_iCallCount++;
                return $_aEnqueueItem;
            }

            /**
             * Formats the SRC value.
             *
             * Also, adds the ability to auto-load a .min file if exists when a path is given (not url).
             *
             * @param   array $aEnqueueItem
             * @return  string
             * @since   3.8.31
             * @remark  This is identical to the AdminPageFramework_Resource_Base::___getSRCFormatted() method.
             * @see     AdminPageFramework_Resource_Base::___getSRCFormatted()
             */
            private function ___getSRCFormatted( array $aEnqueueItem ) {
                $_sSRCRaw = wp_normalize_path( $aEnqueueItem[ 'src' ] );
                $_sSRC    = $this->getResolvedSRC( $_sSRCRaw ); // at this point, it is a URL

                if ( ! $this->oForm->aArguments[ 'autoload_min_resource' ] ) {
                    return $_sSRC;
                }

                // If the site debug mode is on, use the one that user gave.
                if ( $this->isDebugMode() ) {
                    return $_sSRC;
                }

                // If the user gave a url, use it.
                if ( $this->isURL( $_sSRCRaw ) ) {
                    return $_sSRC;
                }

                // At this point, the user gave a path.
                $_sMinPrefix = '.min';

                // If the user already handles a min version, then use it.
                if ( false !== stripos( $_sSRC, $_sMinPrefix ) ) {
                    return $_sSRC;
                }

                $_aPathParts = pathinfo( $_sSRCRaw )
                    + array( 'dirname' => '', 'filename' => '', 'basename' => '', 'extension' => '' ); // avoid undefined index warnings

                // If there is no extension, avoid using a minified version.
                if ( ! $_aPathParts[ 'extension' ] ) {
                    return $_sSRC;
                }

                $_aPathPartsURL = pathinfo( $_sSRC )
                    + array( 'dirname' => '', 'filename' => '', 'basename' => '', 'extension' => '' ); // avoid undefined index warnings

                $_sPathMinifiedVersion = $_aPathParts[ 'dirname' ] . '/' . $_aPathParts[ 'filename' ] . $_sMinPrefix . '.' . $_aPathParts[ 'extension' ];
                return file_exists( $_sPathMinifiedVersion )
                    ? $_aPathPartsURL[ 'dirname' ] . '/' . $_aPathPartsURL[ 'filename' ] . $_sMinPrefix . '.' . $_aPathPartsURL[ 'extension' ]
                    : $_sSRC;

            }

    /**
     * Enqueues inline styles.
     *
     * @since       3.7.0
     * @callback    action      wp_print_footer_scripts
     * @callback    action      wp_print_styles
     * @return      void
     */
    public function _replyToAddStyle() {

        if ( ! $this->oForm->isInThePage() ) {
            return;
        }
        $_sCSSRules = $this->___getFormattedInternalStyles(
            $this->oForm->getResources( 'internal_styles' )
        );

        $_sID = $this->sanitizeSlug( strtolower( $this->oForm->aArguments[ 'caller_id' ] ) );
        if ( $_sCSSRules ) {
            echo "<style type='text/css' id='internal-style-{$_sID}' class='admin-page-framework-form-style'>"
                    . $_sCSSRules
                . "</style>";
        }
        $_sIECSSRules = $this->___getFormattedInternalStyles(
            $this->oForm->getResources( 'internal_styles_ie' )
        );
        if ( $_sIECSSRules ) {
            echo "<!--[if IE]><style type='text/css' id='internal-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( 'internal_styles', array() );
        $this->oForm->setResources( 'internal_styles_ie', array() );

    }
        /**
         * @since       3.7.0
         * @string
         */
        private function ___getFormattedInternalStyles( array $aInternalStyles ) {
            return trim( implode( PHP_EOL, array_unique( $aInternalStyles ) ) );
        }

    /**
     * Enqueues page inline scripts.
     *
     * @since       3.7.0
     */
    public function _replyToAddScript() {

        if ( ! $this->oForm->isInThePage() ) {
            return;
        }

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

    }

}