AdminPageFramework_Form_View__Resource::___setHooks() - Code Metrics - michaeluno/admin-page-framework - Measure and Improve Code Quality continuously with Scrutinizer

___setHooks() A
last analyzed 2022-04-15 19:26 UTC

↳ Parent: AdminPageFramework_Form_View__Resource

Complexity

Conditions	3
Paths	2

Size

Total Lines	27
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	11
dl	0
loc	27
rs	9.9
c	0
b	0
f	0
cc	3
nc	2
nop	0

<?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 ] ) ) {

                    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() );

    }

}

1			<?php
2			/**
3			* Admin Page Framework
4			*
5			* http://admin-page-framework.michaeluno.jp/
6			* Copyright (c) 2013-2022, Michael Uno; Licensed MIT
7			*
8			*/
9
10			/**
11			* Provides methods to build forms.
12			*
13			* This is a delegation class of `AdminPageFramework_Form_View`.
14			*
15			* @package AdminPageFramework/Common/Form/View/Resource
16			* @since 3.7.0
17			* @extends AdminPageFramework_FrameworkUtility
18			* @internal
19			*/
20			class AdminPageFramework_Form_View__Resource extends AdminPageFramework_FrameworkUtility {
21
22			/**
23			* Stores the form object to let this class access the resource array.
24			* @var AdminPageFramework_Form
25			*/
26			public $oForm;
27
28			/**
29			* Sets up hooks.
30			* @since 3.7.0
31			*/
32			public function __construct( $oForm ) {
33
34			$this->oForm = $oForm;
35
36			// If it is loaded in the background, no need to load scripts and styles.
37			if ( $this->isDoingAjax() ) {
38			return;
39			}
40
41			// Widgets can be called multiple times for the number of user-created widget instances for one class instance
42			// so make sure it is processed only once per page.
43			if ( $this->hasBeenCalled( 'resource_' . $oForm->aArguments[ 'caller_id' ] ) ) {
44			return;
45			}
46
47			$this->___setHooks();
48
49			}
50
51			/**
52			* @since 3.7.0
53			*/
54			private function ___setHooks() {
55
56			if ( is_admin() ) {
57			$this->___setAdminHooks();
58			return;
59			}
60
61			// Hook the admin header to insert custom admin stylesheets and scripts.
62			add_action( 'wp_enqueue_scripts', array( $this, '_replyToEnqueueScripts' ) );
63			add_action( 'wp_enqueue_scripts', array( $this, '_replyToEnqueueStyles' ) );
64
65			/// A low priority is required to let dependencies loaded fast especially in customizer.php.
66			add_action( did_action( 'wp_print_styles' ) ? 'wp_print_footer_scripts' : 'wp_print_styles', array( $this, '_replyToAddStyle' ), 999 );
67			// 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.
68
69			// Take care of items that could not be added in the head tag.
70
71			/// For admin pages other than wp-admin/customizer.php
72			add_action( 'wp_footer', array( $this, '_replyToEnqueueScripts' ) );
73			add_action( 'wp_footer', array( $this, '_replyToEnqueueStyles' ) );
74
75			/// For all admin pages.
76			add_action( 'wp_print_footer_scripts', array( $this, '_replyToAddStyle' ), 999 );
77			add_action( 'wp_print_footer_scripts', array( $this, '_replyToAddScript' ), 999 );
78
79			// Required scripts in the head tag.
80			new AdminPageFramework_Form_View__Resource__Head( $this->oForm, 'wp_head' );
81
82			}
83			private function ___setAdminHooks() {
84
85			// Hook the admin header to insert custom admin stylesheets and scripts.
86			add_action( 'admin_enqueue_scripts', array( $this, '_replyToEnqueueScripts' ) );
87			add_action( 'admin_enqueue_scripts', array( $this, '_replyToEnqueueStyles' ) );
88
89			add_action( did_action( 'admin_print_styles' ) ? 'admin_print_footer_scripts' : 'admin_print_styles', array( $this, '_replyToAddStyle' ), 999 );
90			// 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.
91
92			// Take care of items that could not be added in the head tag.
93			/// For wp-admin/customizer.php
94			add_action( 'customize_controls_print_footer_scripts', array( $this, '_replyToEnqueueScripts' ) );
95			add_action( 'customize_controls_print_footer_scripts', array( $this, '_replyToEnqueueStyles' ) );
96
97			/// For admin pages other than wp-admin/customizer.php
98			add_action( 'admin_footer', array( $this, '_replyToEnqueueScripts' ) );
99			add_action( 'admin_footer', array( $this, '_replyToEnqueueStyles' ) );
100
101			/// For all admin pages.
102			add_action( 'admin_print_footer_scripts', array( $this, '_replyToAddStyle' ), 999 );
103			add_action( 'admin_print_footer_scripts', array( $this, '_replyToAddScript' ), 999 );
104
105			// Required scripts in the head tag.
106			new AdminPageFramework_Form_View__Resource__Head( $this->oForm, 'admin_head' );
107
108			}
109
110			/**
111			* Enqueues page script resources.
112			*
113			* @since 3.7.0
114			*/
115			public function _replyToEnqueueScripts() {
116			if ( ! $this->oForm->isInThePage() ) {
117			return;
118			}
119			$_aRegister = $this->oForm->getResources( 'register' );
120			foreach( $this->getElementAsArray( $_aRegister, array( 'scripts' ) ) as $_iIndex => $_aRegister ) {
121			$this->___registerScript( $_aRegister );
122			}
123			foreach( $this->oForm->getResources( 'src_scripts' ) as $_isIndex => $_asEnqueue ) {
124			$this->___enqueueScript( $_asEnqueue );
125			$this->oForm->unsetResources( array( 'src_scripts', $_isIndex ) ); // no longer needed
126			}
127			}
128			/**
129			* @param array $aRegister
130			* @since 3.9.0
131			*/
132			private function ___registerScript( array $aRegister ) {
133
134			$aRegister = $aRegister + array(
135			'handle_id' => '', 'src' => '',
136			'dependencies' => array(), 'version' => false,
137			'in_footer' => false,
138			'translation' => array(), 'translation_var' => '',
139			);
140			$_bRegistered = wp_register_script(
141			$aRegister[ 'handle_id' ],
142			$this->___getSRCFormatted( $aRegister ),
143			$aRegister[ 'dependencies' ],
144			$aRegister[ 'version' ],
145			$aRegister[ 'in_footer' ]
146			);
147			if ( $_bRegistered && ! empty( $aRegister[ 'translation' ] ) ) {
148			wp_localize_script(
149			$aRegister[ 'handle_id' ],
150			$aRegister[ 'translation_var' ] ? $aRegister[ 'translation_var' ] : $aRegister[ 'translation_var' ],
151			$this->getAsArray( $aRegister[ 'translation' ] )
152			);
153			}
154
155			}
156			/**
157			* Stores flags of enqueued items.
158			* @since 3.7.0
159			*/
160			static private $_aEnqueued = array();
161			/**
162			* @return void
163			* @since 3.7.0
164			*/
165			private function ___enqueueScript( $asEnqueue ) {
166
167			$_sSetHandleID = $this->getElement( $this->getAsArray( $asEnqueue ), 'handle_id', '' );
168			$_aEnqueueItem = $this->___getFormattedEnqueueScript( $asEnqueue );
169			$_sCacheID = $_sSetHandleID . $this->getElement( $_aEnqueueItem, 'src', '' );
170
171			// Do not load the same items multiple times.
172			// 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
173			// 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.
174			if ( ! empty( $_sCacheID ) && isset( self::$_aEnqueued[ $_sCacheID ] ) ) {
175			return;
176			}
177			self::$_aEnqueued[ $_sCacheID ] = $_aEnqueueItem;
178
179			wp_enqueue_script(
180			$_aEnqueueItem[ 'handle_id' ],
181			$_aEnqueueItem[ 'src' ],
182			$_aEnqueueItem[ 'dependencies' ],
183			$_aEnqueueItem[ 'version' ],
184			did_action( 'admin_body_class' ) \|\| ( boolean ) $_aEnqueueItem[ 'in_footer' ]
185			);
186			if ( $_aEnqueueItem[ 'translation' ] ) {
187			wp_localize_script(
188			$_aEnqueueItem[ 'handle_id' ],
189			empty( $_aEnqueueItem[ 'translation_var' ] ) ? $_aEnqueueItem[ 'handle_id' ] : $_aEnqueueItem[ 'translation_var' ],
190			$_aEnqueueItem[ 'translation' ]
191			);
192			}
193			if ( $_aEnqueueItem[ 'conditional' ] ) {
194			wp_script_add_data( $_aEnqueueItem[ 'handle_id' ], 'conditional', $_aEnqueueItem[ 'conditional' ] );
195			}
196
197			}
198			/**
199			* @return array
200			* @since 3.7.0
201			*/
202			private function ___getFormattedEnqueueScript( $asEnqueue ) {
203			static $_iCallCount = 1;
204			$_aEnqueueItem = $this->getAsArray( $asEnqueue ) + array(
205			'handle_id' => 'admin-page-framework-script-form-' . $this->oForm->aArguments[ 'caller_id' ] . '_' . $_iCallCount,
206			'src' => null,
207			'dependencies' => null,
208			'version' => null,
209			'in_footer' => false,
210			'translation' => null,
211			'conditional' => null,
212			'translation_var' => null,
213			);
214			if ( is_string( $asEnqueue ) ) {
215			$_aEnqueueItem[ 'src' ] = $asEnqueue;
216			}
217			$_aEnqueueItem[ 'src' ] = $this->___getSRCFormatted( $_aEnqueueItem );
218			$_iCallCount++;
219			return $_aEnqueueItem;
220			}
221
222
223			/**
224			* Enqueues page stylesheet resources.
225			*
226			* @since 3.7.0
227			*/
228			public function _replyToEnqueueStyles() {
229
230			if ( ! $this->oForm->isInThePage() ) {
231			return;
232			}
233			$_aRegister = $this->oForm->getResources( 'register' );
234			foreach( $this->getElementAsArray( $_aRegister, array( 'styles' ) ) as $_iIndex => $_aRegister ) {
235			$this->___registerStyle( $_aRegister );
236			}
237			foreach( $this->oForm->getResources( 'src_styles' ) as $_isIndex => $_asEnqueueItem ) {
238			$this->___enqueueStyle( $_asEnqueueItem );
239			$this->oForm->unsetResources( array( 'src_styles', $_isIndex ) ); // no longer needed
240			}
241
242			}
243			/**
244			* @param array $aRegister
245			* @since 3.9.0
246			*/
247			private function ___registerStyle( array $aRegister ) {
248			$_aRegister = $aRegister + array(
249			'handle_id' => null, 'src' => null,
250			'dependencies' => array(), 'version' => false,
251			'media' => 'all',
252			);
253			wp_register_style(
254			$_aRegister[ 'handle_id' ],
255			$this->___getSRCFormatted( $_aRegister ),
256			$_aRegister[ 'dependencies' ],
257			$_aRegister[ 'version' ],
258			$_aRegister[ 'media' ]
259			);
260			}
261			/**
262			* @param array\|string $asEnqueue
263			* @since 3.9.0
264			*/
265			private function ___enqueueStyle( $asEnqueue ) {
266			$_aEnqueueItem = $this->___getFormattedEnqueueStyle( $asEnqueue );
267			wp_enqueue_style(
268			$_aEnqueueItem[ 'handle_id' ],
269			$_aEnqueueItem[ 'src' ],
270			$_aEnqueueItem[ 'dependencies' ],
271			$_aEnqueueItem[ 'version' ],
272			$_aEnqueueItem[ 'media' ]
273			);
274			$_aAddData = array( 'conditional', 'rtl', 'suffix', 'alt', 'title' );
275			foreach( $_aAddData as $_sDataKey ) {
276			if ( ! isset( $aEnqueueItem[ $_sDataKey ] ) ) {
			0 ignored issues – show Comprehensibility Best Practice introduced 2022-02-27 03:17 UTC by Report Bug Copy Issue Report The variable `$aEnqueueItem` does not exist. Did you maybe mean `$_aEnqueueItem`? Loading history...
277			continue;
278			}
279			wp_style_add_data( $aEnqueueItem[ 'handle_id' ], $_sDataKey, $aEnqueueItem[ $_sDataKey ] );
280			}
281			}
282			/**
283			* @return array
284			*/
285			private function ___getFormattedEnqueueStyle( $asEnqueue ) {
286			static $_iCallCount = 1;
287			$_aEnqueueItem = $this->getAsArray( $asEnqueue ) + array(
288			'handle_id' => 'admin-page-framework-style-form-' . $this->oForm->aArguments[ 'caller_id' ] . '_' . $_iCallCount,
289			'src' => null, 'dependencies' => null,
290			'version' => null, 'media' => null,
291			'conditional' => null,
292			'rtl' => null, 'suffix' => null,
293			'alt' => null, 'title' => null,
294			);
295			if ( is_string( $asEnqueue ) ) {
296			$_aEnqueueItem[ 'src' ] = $asEnqueue;
297			}
298			$_aEnqueueItem[ 'src' ] = $this->___getSRCFormatted( $_aEnqueueItem );
299			$_iCallCount++;
300			return $_aEnqueueItem;
301			}
302
303			/**
304			* Formats the SRC value.
305			*
306			* Also, adds the ability to auto-load a .min file if exists when a path is given (not url).
307			*
308			* @param array $aEnqueueItem
309			* @return string
310			* @since 3.8.31
311			* @remark This is identical to the AdminPageFramework_Resource_Base::___getSRCFormatted() method.
312			* @see AdminPageFramework_Resource_Base::___getSRCFormatted()
313			*/
314			private function ___getSRCFormatted( array $aEnqueueItem ) {
315			$_sSRCRaw = wp_normalize_path( $aEnqueueItem[ 'src' ] );
316			$_sSRC = $this->getResolvedSRC( $_sSRCRaw ); // at this point, it is a URL
317
318			if ( ! $this->oForm->aArguments[ 'autoload_min_resource' ] ) {
319			return $_sSRC;
320			}
321
322			// If the site debug mode is on, use the one that user gave.
323			if ( $this->isDebugMode() ) {
324			return $_sSRC;
325			}
326
327			// If the user gave a url, use it.
328			if ( $this->isURL( $_sSRCRaw ) ) {
329			return $_sSRC;
330			}
331
332			// At this point, the user gave a path.
333			$_sMinPrefix = '.min';
334
335			// If the user already handles a min version, then use it.
336			if ( false !== stripos( $_sSRC, $_sMinPrefix ) ) {
337			return $_sSRC;
338			}
339
340			$_aPathParts = pathinfo( $_sSRCRaw )
341			+ array( 'dirname' => '', 'filename' => '', 'basename' => '', 'extension' => '' ); // avoid undefined index warnings
342
343			// If there is no extension, avoid using a minified version.
344			if ( ! $_aPathParts[ 'extension' ] ) {
345			return $_sSRC;
346			}
347
348			$_aPathPartsURL = pathinfo( $_sSRC )
349			+ array( 'dirname' => '', 'filename' => '', 'basename' => '', 'extension' => '' ); // avoid undefined index warnings
350
351			$_sPathMinifiedVersion = $_aPathParts[ 'dirname' ] . '/' . $_aPathParts[ 'filename' ] . $_sMinPrefix . '.' . $_aPathParts[ 'extension' ];
352			return file_exists( $_sPathMinifiedVersion )
353			? $_aPathPartsURL[ 'dirname' ] . '/' . $_aPathPartsURL[ 'filename' ] . $_sMinPrefix . '.' . $_aPathPartsURL[ 'extension' ]
354			: $_sSRC;
355
356			}
357
358			/**
359			* Enqueues inline styles.
360			*
361			* @since 3.7.0
362			* @callback action wp_print_footer_scripts
363			* @callback action wp_print_styles
364			* @return void
365			*/
366			public function _replyToAddStyle() {
367
368			if ( ! $this->oForm->isInThePage() ) {
369			return;
370			}
371			$_sCSSRules = $this->___getFormattedInternalStyles(
372			$this->oForm->getResources( 'internal_styles' )
373			);
374
375			$_sID = $this->sanitizeSlug( strtolower( $this->oForm->aArguments[ 'caller_id' ] ) );
376			if ( $_sCSSRules ) {
377			echo "<style type='text/css' id='internal-style-{$_sID}' class='admin-page-framework-form-style'>"
378			. $_sCSSRules
379			. "</style>";
380			}
381			$_sIECSSRules = $this->___getFormattedInternalStyles(
382			$this->oForm->getResources( 'internal_styles_ie' )
383			);
384			if ( $_sIECSSRules ) {
385			echo "<!--[if IE]><style type='text/css' id='internal-style-ie-{$_sID}' class='admin-page-framework-form-ie-style'>"
386			. $_sIECSSRules
387			. "</style><![endif]-->";
388			}
389
390			// Empty the values as this method can be called multiple times, in the head tag and the footer.
391			$this->oForm->setResources( 'internal_styles', array() );
392			$this->oForm->setResources( 'internal_styles_ie', array() );
393
394			}
395			/**
396			* @since 3.7.0
397			* @string
398			*/
399			private function ___getFormattedInternalStyles( array $aInternalStyles ) {
400			return trim( implode( PHP_EOL, array_unique( $aInternalStyles ) ) );
401			}
402
403			/**
404			* Enqueues page inline scripts.
405			*
406			* @since 3.7.0
407			*/
408			public function _replyToAddScript() {
409
410			if ( ! $this->oForm->isInThePage() ) {
411			return;
412			}
413
414			$_sScript = implode( PHP_EOL, array_unique( $this->oForm->getResources( 'internal_scripts' ) ) );
415			$_sScript = trim( $_sScript );
416			if ( $_sScript ) {
417			$_sID = $this->sanitizeSlug( strtolower( $this->oForm->aArguments[ 'caller_id' ] ) );
418			echo "<script type='text/javascript' id='internal-script-{$_sID}' class='admin-page-framework-form-script'>"
419			. '/* <![CDATA[ */'
420			. $_sScript
421			. '/* ]]> */'
422			. "</script>";
423			}
424			$this->oForm->setResources( 'internal_scripts', array() );
425
426			}
427
428			}

michaeluno / admin-page-framework

___setHooks() A last analyzed 2022-04-15 19:26 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

___setHooks() A
last analyzed 2022-04-15 19:26 UTC