EventEspresso\core\services\assets\Registry

Complexity

Total Complexity

58

Size/Duplication

Total Lines	702
Duplicated Lines	5.27 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes	12
Bugs	1	Features	4

26 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	22	1
A	getI18nRegistry()	0	4	1
A	enqueueData()	0	13	1
A	addData()	0	6	2
A	pushData()	15	19	3
A	addTemplate()	0	19	3
A	getTemplate()	0	6	2
A	getData()	0	6	2
A	getAssetUrl()	0	17	2
A	getJsUrl()	0	4	1
A	getCssUrl()	0	4	1
B	registerManifestFile()	0	38	5
A	decodeManifestFile()	0	7	2
B	verifyDataNotExisting()	14	30	3
B	loadCoreCss()	0	23	4
A	loadCoreJs()	0	11	1
A	loadJqueryValidate()	0	18	1
A	loadAccountingJs()	0	19	1
B	localizeAccountingJs()	0	26	4
A	loadQtipJs()	0	8	2
A	addRegisteredScriptHandlesWithData()	0	4	1
A	removeAlreadyRegisteredDataForScriptHandles()	0	9	3
B	removeAlreadyRegisteredDataForScriptHandle()	8	22	6
A	registerAdminAssets()	0	20	1
A	registerTranslationsForHandles()	0	6	2
A	scripts()	0	47	3

<?php

namespace EventEspresso\core\services\assets;

use EE_Currency_Config;
use EE_Error;
use EE_Registry;
use EE_Template_Config;
use EEH_Qtip_Loader;
use EventEspresso\core\domain\DomainInterface;
use EventEspresso\core\exceptions\InvalidFilePathException;
use InvalidArgumentException;

defined('EVENT_ESPRESSO_VERSION') || exit;



/**
 * Used for registering assets used in EE.
 *
 * @package    EventEspresso
 * @subpackage services\assets
 * @author     Darren Ethier
 * @since      4.9.24.rc.004
 */
class Registry
{

    const ASSET_TYPE_CSS = 'css';
    const ASSET_TYPE_JS = 'js';
    const ASSET_NAMESPACE = 'core';

    /**
     * @var EE_Template_Config $template_config
     */
    protected $template_config;

    /**
     * @var EE_Currency_Config $currency_config
     */
    protected $currency_config;

    /**
     * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
     *
     * @var array
     */
    protected $jsdata = array();


    /**
     * This keeps track of all scripts with registered data.  It is used to prevent duplicate data objects setup in the
     * page source.
     * @var array
     */
    protected $script_handles_with_data = array();


    /**
     * @var DomainInterface
     */
    protected $domain;


    /**
     * @var I18nRegistry
     */
    private $i18n_registry;



    /**
     * Holds the manifest data obtained from registered manifest files.
     * Manifests are maps of asset chunk name to actual built asset file names.
     * Shape of this array is:
     *
     * array(
     *  'some_namespace_slug' => array(
     *      'some_chunk_name' => array(
     *          'js' => 'filename.js'
     *          'css' => 'filename.js'
     *      ),
     *      'url_base' => 'https://baseurl.com/to/assets
     *  )
     * )
     *
     * @var array
     */
    private $manifest_data = array();


    /**
     * Registry constructor.
     * Hooking into WP actions for script registry.
     *
     * @param EE_Template_Config $template_config
     * @param EE_Currency_Config $currency_config
     * @param I18nRegistry       $i18n_registry
     * @param DomainInterface    $domain
     * @throws InvalidArgumentException
     * @throws InvalidFilePathException
     */
    public function __construct(
        EE_Template_Config $template_config,
        EE_Currency_Config $currency_config,
        I18nRegistry $i18n_registry,
        DomainInterface $domain
    ) {
        $this->template_config = $template_config;
        $this->currency_config = $currency_config;
        $this->domain = $domain;
        $this->i18n_registry = $i18n_registry;
        $this->registerManifestFile(
            self::ASSET_NAMESPACE,
            $this->domain->distributionAssetsUrl(),
            $this->domain->distributionAssetsPath() . 'build-manifest.json'
        );
        add_action('wp_enqueue_scripts', array($this, 'scripts'), 1);
        add_action('admin_enqueue_scripts', array($this, 'scripts'), 1);
        add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 2);
        add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 2);
        add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
        add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
    }


    /**
     * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n
     * translation handling.
     *
     * @return I18nRegistry
     */
    public function getI18nRegistry()
    {
        return $this->i18n_registry;
    }

    /**
     * Callback for the WP script actions.
     * Used to register globally accessible core scripts.
     * Also used to add the eejs.data object to the source for any js having eejs-core as a dependency.
     *
     */
    public function scripts()
    {
        global $wp_version;
        wp_register_script(
            'ee-manifest',
            $this->getJsUrl(self::ASSET_NAMESPACE, 'manifest'),
            array(),
            null,
            true
        );
        wp_register_script(
            'eejs-core',
            $this->getJsUrl(self::ASSET_NAMESPACE, 'eejs'),
            array('ee-manifest'),
            null,
            true
        );
        wp_register_script(
            'ee-vendor-react',
            $this->getJsUrl(self::ASSET_NAMESPACE, 'reactVendor'),
            array('eejs-core'),
            null,
            true
        );
        //only run this if WordPress 4.4.0 > is in use.
        if (version_compare($wp_version, '4.4.0', '>')) {
            //js.api
            wp_register_script(
                'eejs-api',
                EE_LIBRARIES_URL . 'rest_api/assets/js/eejs-api.min.js',
                array('underscore', 'eejs-core'),
                EVENT_ESPRESSO_VERSION,
                true
            );
            $this->jsdata['eejs_api_nonce'] = wp_create_nonce('wp_rest');
            $this->jsdata['paths'] = array('rest_route' => rest_url('ee/v4.8.36/'));
        }
        if (! is_admin()) {
            $this->loadCoreCss();
        }
        $this->registerTranslationsForHandles(array('eejs-core'));
        $this->loadCoreJs();
        $this->loadJqueryValidate();
        $this->loadAccountingJs();
        $this->loadQtipJs();
        $this->registerAdminAssets();
    }



    /**
     * Call back for the script print in frontend and backend.
     * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
     *
     * @since 4.9.31.rc.015
     */
    public function enqueueData()
    {
        $this->removeAlreadyRegisteredDataForScriptHandles();
        wp_add_inline_script(
            'eejs-core',
            'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
            'before'
        );
        wp_localize_script('espresso_core', 'eei18n', EE_Registry::$i18n_js_strings);
        $this->localizeAccountingJs();
        $this->addRegisteredScriptHandlesWithData('eejs-core');
        $this->addRegisteredScriptHandlesWithData('espresso_core');
    }



    /**
     * Used to add data to eejs.data object.
     * Note:  Overriding existing data is not allowed.
     * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
     * If the data you add is something like this:
     *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
     * It will be exposed in the page source as:
     *  eejs.data.my_plugin_data.foo == gar
     *
     * @param string       $key   Key used to access your data
     * @param string|array $value Value to attach to key
     * @throws InvalidArgumentException
     */
    public function addData($key, $value)
    {
        if ($this->verifyDataNotExisting($key)) {
            $this->jsdata[$key] = $value;
        }
    }



    /**
     * Similar to addData except this allows for users to push values to an existing key where the values on key are
     * elements in an array.
     * When you use this method, the value you include will be appended to the end of an array on $key.
     * So if the $key was 'test' and you added a value of 'my_data' then it would be represented in the javascript
     * object like this, eejs.data.test = [ my_data,
     * ]
     * If there has already been a scalar value attached to the data object given key, then
     * this will throw an exception.
     *
     * @param string       $key   Key to attach data to.
     * @param string|array $value Value being registered.
     * @throws InvalidArgumentException
     */
    public function pushData($key, $value)
    {
        if (isset($this->jsdata[$key])
            && ! is_array($this->jsdata[$key])
        ) {
            throw new invalidArgumentException(
                sprintf(
                    __(
                        'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
                         push values to this data element when it is an array.',
                        'event_espresso'
                    ),
                    $key,
                    __METHOD__
                )
            );
        }
        $this->jsdata[$key][] = $value;
    }



    /**
     * Used to set content used by javascript for a template.
     * Note: Overrides of existing registered templates are not allowed.
     *
     * @param string $template_reference
     * @param string $template_content
     * @throws InvalidArgumentException
     */
    public function addTemplate($template_reference, $template_content)
    {
        if (! isset($this->jsdata['templates'])) {
            $this->jsdata['templates'] = array();
        }
        //no overrides allowed.
        if (isset($this->jsdata['templates'][$template_reference])) {
            throw new invalidArgumentException(
                sprintf(
                    __(
                        'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
                        'event_espresso'
                    ),
                    $template_reference
                )
            );
        }
        $this->jsdata['templates'][$template_reference] = $template_content;
    }



    /**
     * Retrieve the template content already registered for the given reference.
     *
     * @param string $template_reference
     * @return string
     */
    public function getTemplate($template_reference)
    {
        return isset($this->jsdata['templates'], $this->jsdata['templates'][$template_reference])
            ? $this->jsdata['templates'][$template_reference]
            : '';
    }



    /**
     * Retrieve registered data.
     *
     * @param string $key Name of key to attach data to.
     * @return mixed                If there is no for the given key, then false is returned.
     */
    public function getData($key)
    {
        return isset($this->jsdata[$key])
            ? $this->jsdata[$key]
            : false;
    }


    /**
     * Get the actual asset path for asset manifests.
     * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned.
     * @param string $namespace  The namespace associated with the manifest file hosting the map of chunk_name to actual
     *                           asset file location.
     * @param string $chunk_name
     * @param string $asset_type
     * @return string
     * @since 4.9.59.p
     */
    public function getAssetUrl($namespace, $chunk_name, $asset_type)
    {
        $url = isset(
            $this->manifest_data[$namespace][$chunk_name][$asset_type],
            $this->manifest_data[$namespace]['url_base']
        )
            ? $this->manifest_data[$namespace]['url_base']
              . $this->manifest_data[$namespace][$chunk_name][$asset_type]
            : $chunk_name;
        return apply_filters(
            'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
            $url,
            $namespace,
            $chunk_name,
            $asset_type
        );
    }


    /**
     * Return the url to a js file for the given namespace and chunk name.
     *
     * @param string $namespace
     * @param string $chunk_name
     * @return string
     */
    public function getJsUrl($namespace, $chunk_name)
    {
        return $this->getAssetUrl($namespace, $chunk_name, self::ASSET_TYPE_JS);
    }


    /**
     * Return the url to a css file for the given namespace and chunk name.
     *
     * @param string $namespace
     * @param string $chunk_name
     * @return string
     */
    public function getCssUrl($namespace, $chunk_name)
    {
        return $this->getAssetUrl($namespace, $chunk_name, self::ASSET_TYPE_CSS);
    }


    /**
     * Used to register a js/css manifest file with the registered_manifest_files property.
     *
     * @param string $namespace     Provided to associate the manifest file with a specific namespace.
     * @param string $url_base      The url base for the manifest file location.
     * @param string $manifest_file The absolute path to the manifest file.
     * @throws InvalidArgumentException
     * @throws InvalidFilePathException
     * @since 4.9.59.p
     */
    public function registerManifestFile($namespace, $url_base, $manifest_file)
    {
        if (isset($this->manifest_data[$namespace])) {
            throw new InvalidArgumentException(
                sprintf(
                    esc_html__(
                        'The namespace for this manifest file has already been registered, choose a namespace other than %s',
                        'event_espresso'
                    ),
                    $namespace
                )
            );
        }
        if (filter_var($url_base, FILTER_VALIDATE_URL) === false) {
            if (is_admin()) {
                EE_Error::add_error(
                    sprintf(
                        esc_html__(
                            'The url given for %1$s assets is invalid.  The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant',
                            'event_espresso'
                        ),
                        'Event Espresso',
                        $url_base,
                        'plugins_url',
                        'WP_PLUGIN_URL'
                    ),
                    __FILE__,
                    __FUNCTION__,
                    __LINE__
                );
            }
            return;
        }
        $this->manifest_data[$namespace] = $this->decodeManifestFile($manifest_file);
        if (! isset($this->manifest_data[$namespace]['url_base'])) {
            $this->manifest_data[$namespace]['url_base'] = trailingslashit($url_base);
        }
    }



    /**
     * Decodes json from the provided manifest file.
     *
     * @since 4.9.59.p
     * @param string $manifest_file Path to manifest file.
     * @return array
     * @throws InvalidFilePathException
     */
    private function decodeManifestFile($manifest_file)
    {
        if (! file_exists($manifest_file)) {
            throw new InvalidFilePathException($manifest_file);
        }
        return json_decode(file_get_contents($manifest_file), true);
    }



    /**
     * Verifies whether the given data exists already on the jsdata array.
     * Overriding data is not allowed.
     *
     * @param string $key Index for data.
     * @return bool        If valid then return true.
     * @throws InvalidArgumentException if data already exists.
     */
    protected function verifyDataNotExisting($key)
    {
        if (isset($this->jsdata[$key])) {
            if (is_array($this->jsdata[$key])) {
                throw new InvalidArgumentException(
                    sprintf(
                        __(
                            'The value for %1$s already exists in the Registry::eejs object.
                            Overrides are not allowed. Since the value of this data is an array, you may want to use the
                            %2$s method to push your value to the array.',
                            'event_espresso'
                        ),
                        $key,
                        'pushData()'
                    )
                );
            }
            throw new InvalidArgumentException(
                sprintf(
                    __(
                        'The value for %1$s already exists in the Registry::eejs object. Overrides are not
                        allowed.  Consider attaching your value to a different key',
                        'event_espresso'
                    ),
                    $key
                )
            );
        }
        return true;
    }



    /**
     * registers core default stylesheets
     */
    private function loadCoreCss()
    {
        if ($this->template_config->enable_default_style) {
            $default_stylesheet_path = is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')
                ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css'
                : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css';
            wp_register_style(
                'espresso_default',
                $default_stylesheet_path,
                array('dashicons'),
                EVENT_ESPRESSO_VERSION
            );
            //Load custom style sheet if available
            if ($this->template_config->custom_style_sheet !== null) {
                wp_register_style(
                    'espresso_custom_css',
                    EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet,
                    array('espresso_default'),
                    EVENT_ESPRESSO_VERSION
                );
            }
        }
    }



    /**
     * registers core default javascript
     */
    private function loadCoreJs()
    {
        // load core js
        wp_register_script(
            'espresso_core',
            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
            array('jquery'),
            EVENT_ESPRESSO_VERSION,
            true
        );
    }



    /**
     * registers jQuery Validate for form validation
     */
    private function loadJqueryValidate()
    {
        // register jQuery Validate and additional methods
        wp_register_script(
            'jquery-validate',
            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
            array('jquery'),
            '1.15.0',
            true
        );
        wp_register_script(
            'jquery-validate-extra-methods',
            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
            array('jquery', 'jquery-validate'),
            '1.15.0',
            true
        );
    }



    /**
     * registers accounting.js for performing client-side calculations
     */
    private function loadAccountingJs()
    {
        //accounting.js library
        // @link http://josscrowcroft.github.io/accounting.js/
        wp_register_script(
            'ee-accounting-core',
            EE_THIRD_PARTY_URL . 'accounting/accounting.js',
            array('underscore'),
            '0.3.2',
            true
        );
        wp_register_script(
            'ee-accounting',
            EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js',
            array('ee-accounting-core'),
            EVENT_ESPRESSO_VERSION,
            true
        );
    }



    /**
     * registers accounting.js for performing client-side calculations
     */
    private function localizeAccountingJs()
    {
        wp_localize_script(
            'ee-accounting',
            'EE_ACCOUNTING_CFG',
            array(
                'currency' => array(
                    'symbol'    => $this->currency_config->sign,
                    'format'    => array(
                        'pos'  => $this->currency_config->sign_b4 ? '%s%v' : '%v%s',
                        'neg'  => $this->currency_config->sign_b4 ? '- %s%v' : '- %v%s',
                        'zero' => $this->currency_config->sign_b4 ? '%s--' : '--%s',
                    ),
                    'decimal'   => $this->currency_config->dec_mrk,
                    'thousand'  => $this->currency_config->thsnds,
                    'precision' => $this->currency_config->dec_plc,
                ),
                'number'   => array(
                    'precision' => $this->currency_config->dec_plc,
                    'thousand'  => $this->currency_config->thsnds,
                    'decimal'   => $this->currency_config->dec_mrk,
                ),
            )
        );
        $this->addRegisteredScriptHandlesWithData('ee-accounting');
    }



    /**
     * registers assets for cleaning your ears
     */
    private function loadQtipJs()
    {
        // qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook,
        // can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' );
        if (apply_filters('FHEE_load_qtip', false)) {
            EEH_Qtip_Loader::instance()->register_and_enqueue();
        }
    }


    /**
     * This is used to set registered script handles that have data.
     * @param string $script_handle
     */
    private function addRegisteredScriptHandlesWithData($script_handle)
    {
        $this->script_handles_with_data[$script_handle] = $script_handle;
    }


    /**i
     * Checks WP_Scripts for all of each script handle registered internally as having data and unsets from the
     * Dependency stored in WP_Scripts if its set.
     */
    private function removeAlreadyRegisteredDataForScriptHandles()
    {
        if (empty($this->script_handles_with_data)) {
            return;
        }
        foreach ($this->script_handles_with_data as $script_handle) {
            $this->removeAlreadyRegisteredDataForScriptHandle($script_handle);
        }
    }


    /**
     * Removes any data dependency registered in WP_Scripts if its set.
     * @param string $script_handle
     */
    private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
    {
        if (isset($this->script_handles_with_data[$script_handle])) {
            global $wp_scripts;
            $unset_handle = false;
            if ($wp_scripts->get_data($script_handle, 'data')) {
                unset($wp_scripts->registered[$script_handle]->extra['data']);
                $unset_handle = true;
            }
            //deal with inline_scripts
            if ($wp_scripts->get_data($script_handle, 'before')) {
                unset($wp_scripts->registered[$script_handle]->extra['before']);
                $unset_handle = true;
            }
            if ($wp_scripts->get_data($script_handle, 'after')) {
                unset($wp_scripts->registered[$script_handle]->extra['after']);
            }
            if ($unset_handle) {
                unset($this->script_handles_with_data[$script_handle]);
            }
        }
    }


    /**
     * Registers assets that are used in the WordPress admin.
     */
    private function registerAdminAssets()
    {
        wp_register_script(
            'ee-wp-plugins-page',
            $this->getJsUrl(self::ASSET_NAMESPACE, 'wp-plugins-page'),
            array(
                'jquery',
                'ee-vendor-react'
            ),
            null,
            true
        );
        wp_register_style(
            'ee-wp-plugins-page',
            $this->getCssUrl(self::ASSET_NAMESPACE, 'wp-plugins-page'),
            array(),
            null
        );
        $this->registerTranslationsForHandles(array('ee-wp-plugins-page'));
    }


    /**
     * All handles that are registered via the registry that might have translations have their translations registered
     *
     * @param array $handles_to_register
     */
    private function registerTranslationsForHandles(array $handles_to_register)
    {
        foreach($handles_to_register as $handle) {
            $this->i18n_registry->registerScriptI18n($handle);
        }
    }
}