eventespresso / event-espresso-core

core/services/assets/Registry.php

Indentation +583 added lines, -583 removed lines

@@ -23,594 +23,594 @@
 class Registry
 {
 
-    const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';
-
-    /**
-     * @var AssetCollection $assets
-     */
-    protected $assets;
-
-    /**
-     * @var I18nRegistry
-     */
-    private $i18n_registry;
-
-    /**
-     * 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
-     */
-    private $script_handles_with_data = array();
-
-
-    /**
-     * 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 AssetCollection $assets
-     * @param I18nRegistry    $i18n_registry
-     */
-    public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry)
-    {
-        $this->assets = $assets;
-        $this->i18n_registry = $i18n_registry;
-        add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
-        add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
-        add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
-        add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
-        add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4);
-        add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4);
-        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_enqueue_scripts actions used to register assets.
-     *
-     * @since 4.9.62.p
-     * @throws Exception
-     */
-    public function registerScriptsAndStyles()
-    {
-        try {
-            $this->registerScripts($this->assets->getJavascriptAssets());
-            $this->registerStyles($this->assets->getStylesheetAssets());
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    /**
-     * Registers JS assets with WP core
-     *
-     * @since 4.9.62.p
-     * @param JavascriptAsset[] $scripts
-     * @throws AssetRegistrationException
-     * @throws InvalidDataTypeException
-     */
-    public function registerScripts(array $scripts)
-    {
-        foreach ($scripts as $script) {
-            // skip to next script if this has already been done
-            if ($script->isRegistered()) {
-                continue;
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
-                $script
-            );
-            $registered = wp_register_script(
-                $script->handle(),
-                $script->source(),
-                $script->dependencies(),
-                $script->version(),
-                $script->loadInFooter()
-            );
-            if (! $registered && $this->debug()) {
-                throw new AssetRegistrationException($script->handle());
-            }
-            $script->setRegistered($registered);
-            if ($script->requiresTranslation()) {
-                $this->registerTranslation($script->handle());
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
-                $script
-            );
-        }
-    }
-
-
-    /**
-     * Registers CSS assets with WP core
-     *
-     * @since 4.9.62.p
-     * @param StylesheetAsset[] $styles
-     * @throws InvalidDataTypeException
-     */
-    public function registerStyles(array $styles)
-    {
-        foreach ($styles as $style) {
-            // skip to next style if this has already been done
-            if ($style->isRegistered()) {
-                continue;
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style',
-                $style
-            );
-            wp_register_style(
-                $style->handle(),
-                $style->source(),
-                $style->dependencies(),
-                $style->version(),
-                $style->media()
-            );
-            $style->setRegistered();
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style',
-                $style
-            );
-        }
-    }
-
-
-    /**
-     * 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'
-        );
-        $scripts = $this->assets->getJavascriptAssetsWithData();
-        foreach ($scripts as $script) {
-            $this->addRegisteredScriptHandlesWithData($script->handle());
-            if ($script->hasInlineDataCallback()) {
-                $localize = $script->inlineDataCallback();
-                $localize();
-            }
-        }
-    }
-
-
-    /**
-     * 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 merged with the 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 (via addData for instance), then
-     * this will throw an exception.
-     *
-     * Caution: Only add data using this method if you are okay with the potential for additional data added on the same
-     * key potentially overriding the existing data on merge (specifically with associative arrays).
-     *
-     * @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 ])
-        ) {
-            if (! $this->debug()) {
-                return;
-            }
-            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
+	const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';
+
+	/**
+	 * @var AssetCollection $assets
+	 */
+	protected $assets;
+
+	/**
+	 * @var I18nRegistry
+	 */
+	private $i18n_registry;
+
+	/**
+	 * 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
+	 */
+	private $script_handles_with_data = array();
+
+
+	/**
+	 * 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 AssetCollection $assets
+	 * @param I18nRegistry    $i18n_registry
+	 */
+	public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry)
+	{
+		$this->assets = $assets;
+		$this->i18n_registry = $i18n_registry;
+		add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
+		add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
+		add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
+		add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
+		add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4);
+		add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4);
+		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_enqueue_scripts actions used to register assets.
+	 *
+	 * @since 4.9.62.p
+	 * @throws Exception
+	 */
+	public function registerScriptsAndStyles()
+	{
+		try {
+			$this->registerScripts($this->assets->getJavascriptAssets());
+			$this->registerStyles($this->assets->getStylesheetAssets());
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	/**
+	 * Registers JS assets with WP core
+	 *
+	 * @since 4.9.62.p
+	 * @param JavascriptAsset[] $scripts
+	 * @throws AssetRegistrationException
+	 * @throws InvalidDataTypeException
+	 */
+	public function registerScripts(array $scripts)
+	{
+		foreach ($scripts as $script) {
+			// skip to next script if this has already been done
+			if ($script->isRegistered()) {
+				continue;
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
+				$script
+			);
+			$registered = wp_register_script(
+				$script->handle(),
+				$script->source(),
+				$script->dependencies(),
+				$script->version(),
+				$script->loadInFooter()
+			);
+			if (! $registered && $this->debug()) {
+				throw new AssetRegistrationException($script->handle());
+			}
+			$script->setRegistered($registered);
+			if ($script->requiresTranslation()) {
+				$this->registerTranslation($script->handle());
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
+				$script
+			);
+		}
+	}
+
+
+	/**
+	 * Registers CSS assets with WP core
+	 *
+	 * @since 4.9.62.p
+	 * @param StylesheetAsset[] $styles
+	 * @throws InvalidDataTypeException
+	 */
+	public function registerStyles(array $styles)
+	{
+		foreach ($styles as $style) {
+			// skip to next style if this has already been done
+			if ($style->isRegistered()) {
+				continue;
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style',
+				$style
+			);
+			wp_register_style(
+				$style->handle(),
+				$style->source(),
+				$style->dependencies(),
+				$style->version(),
+				$style->media()
+			);
+			$style->setRegistered();
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style',
+				$style
+			);
+		}
+	}
+
+
+	/**
+	 * 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'
+		);
+		$scripts = $this->assets->getJavascriptAssetsWithData();
+		foreach ($scripts as $script) {
+			$this->addRegisteredScriptHandlesWithData($script->handle());
+			if ($script->hasInlineDataCallback()) {
+				$localize = $script->inlineDataCallback();
+				$localize();
+			}
+		}
+	}
+
+
+	/**
+	 * 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 merged with the 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 (via addData for instance), then
+	 * this will throw an exception.
+	 *
+	 * Caution: Only add data using this method if you are okay with the potential for additional data added on the same
+	 * key potentially overriding the existing data on merge (specifically with associative arrays).
+	 *
+	 * @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 ])
+		) {
+			if (! $this->debug()) {
+				return;
+			}
+			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__
-                )
-            );
-        }
-        if ( ! isset( $this->jsdata[ $key ] ) ) {
-            $this->jsdata[ $key ] = is_array($value) ? $value : [$value];
-        } else {
-            $this->jsdata[ $key ] = array_merge( $this->jsdata[$key], (array) $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 ])) {
-            if (! $this->debug()) {
-                return;
-            }
-            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'][ $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;
-    }
-
-
-    /**
-     * 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 (! $this->debug()) {
-                return false;
-            }
-            if (is_array($this->jsdata[ $key ])) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        __(
-                            'The value for %1$s already exists in the Registry::eejs object.
+						'event_espresso'
+					),
+					$key,
+					__METHOD__
+				)
+			);
+		}
+		if ( ! isset( $this->jsdata[ $key ] ) ) {
+			$this->jsdata[ $key ] = is_array($value) ? $value : [$value];
+		} else {
+			$this->jsdata[ $key ] = array_merge( $this->jsdata[$key], (array) $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 ])) {
+			if (! $this->debug()) {
+				return;
+			}
+			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'][ $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;
+	}
+
+
+	/**
+	 * 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 (! $this->debug()) {
+				return false;
+			}
+			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
+							'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;
-    }
-
-
-    /**
-     * 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, 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, Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * @since 4.9.62.p
-     * @throws InvalidArgumentException
-     * @throws InvalidFilePathException
-     */
-    public function registerManifestFiles()
-    {
-        $manifest_files = $this->assets->getManifestFiles();
-        foreach ($manifest_files as $manifest_file) {
-            $this->registerManifestFile(
-                $manifest_file->assetNamespace(),
-                $manifest_file->urlBase(),
-                $manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST
-            );
-        }
-    }
-
-
-    /**
-     * 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 ])) {
-            if (! $this->debug()) {
-                return;
-            }
-            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);
-    }
-
-
-    /**
-     * 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
+						'event_espresso'
+					),
+					$key
+				)
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * 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, 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, Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * @since 4.9.62.p
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFilePathException
+	 */
+	public function registerManifestFiles()
+	{
+		$manifest_files = $this->assets->getManifestFiles();
+		foreach ($manifest_files as $manifest_file) {
+			$this->registerManifestFile(
+				$manifest_file->assetNamespace(),
+				$manifest_file->urlBase(),
+				$manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST
+			);
+		}
+	}
+
+
+	/**
+	 * 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 ])) {
+			if (! $this->debug()) {
+				return;
+			}
+			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);
+	}
+
+
+	/**
+	 * 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 ]);
-            }
-        }
-    }
-
-
-    /**
-     * register translations for a registered script
-     *
-     * @param string $handle
-     */
-    public function registerTranslation($handle)
-    {
-        $this->i18n_registry->registerScriptI18n($handle);
-    }
-
-
-    /**
-     * @since 4.9.63.p
-     * @return bool
-     */
-    private function debug()
-    {
-        return apply_filters(
-            'FHEE__EventEspresso_core_services_assets_Registry__debug',
-            defined('EE_DEBUG') && EE_DEBUG
-        );
-    }
+	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 ]);
+			}
+		}
+	}
+
+
+	/**
+	 * register translations for a registered script
+	 *
+	 * @param string $handle
+	 */
+	public function registerTranslation($handle)
+	{
+		$this->i18n_registry->registerScriptI18n($handle);
+	}
+
+
+	/**
+	 * @since 4.9.63.p
+	 * @return bool
+	 */
+	private function debug()
+	{
+		return apply_filters(
+			'FHEE__EventEspresso_core_services_assets_Registry__debug',
+			defined('EE_DEBUG') && EE_DEBUG
+		);
+	}
 }

Spacing +37 added lines, -37 removed lines

@@ -147,7 +147,7 @@ 
                 $script->version(),
                 $script->loadInFooter()
             );
-            if (! $registered && $this->debug()) {
+            if ( ! $registered && $this->debug()) {
                 throw new AssetRegistrationException($script->handle());
             }
             $script->setRegistered($registered);
@@ -207,7 +207,7 @@ 
         $this->removeAlreadyRegisteredDataForScriptHandles();
         wp_add_inline_script(
             'eejs-core',
-            'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
+            'var eejsdata='.wp_json_encode(array('data' => $this->jsdata)),
             'before'
         );
         $scripts = $this->assets->getJavascriptAssetsWithData();
@@ -237,7 +237,7 @@ 
     public function addData($key, $value)
     {
         if ($this->verifyDataNotExisting($key)) {
-            $this->jsdata[ $key ] = $value;
+            $this->jsdata[$key] = $value;
         }
     }
 
@@ -262,10 +262,10 @@ 
      */
     public function pushData($key, $value)
     {
-        if (isset($this->jsdata[ $key ])
-            && ! is_array($this->jsdata[ $key ])
+        if (isset($this->jsdata[$key])
+            && ! is_array($this->jsdata[$key])
         ) {
-            if (! $this->debug()) {
+            if ( ! $this->debug()) {
                 return;
             }
             throw new InvalidArgumentException(
@@ -280,10 +280,10 @@ 
                 )
             );
         }
-        if ( ! isset( $this->jsdata[ $key ] ) ) {
-            $this->jsdata[ $key ] = is_array($value) ? $value : [$value];
+        if ( ! isset($this->jsdata[$key])) {
+            $this->jsdata[$key] = is_array($value) ? $value : [$value];
         } else {
-            $this->jsdata[ $key ] = array_merge( $this->jsdata[$key], (array) $value);
+            $this->jsdata[$key] = array_merge($this->jsdata[$key], (array) $value);
         }
     }
 
@@ -298,12 +298,12 @@ 
      */
     public function addTemplate($template_reference, $template_content)
     {
-        if (! isset($this->jsdata['templates'])) {
+        if ( ! isset($this->jsdata['templates'])) {
             $this->jsdata['templates'] = array();
         }
         //no overrides allowed.
-        if (isset($this->jsdata['templates'][ $template_reference ])) {
-            if (! $this->debug()) {
+        if (isset($this->jsdata['templates'][$template_reference])) {
+            if ( ! $this->debug()) {
                 return;
             }
             throw new InvalidArgumentException(
@@ -316,7 +316,7 @@ 
                 )
             );
         }
-        $this->jsdata['templates'][ $template_reference ] = $template_content;
+        $this->jsdata['templates'][$template_reference] = $template_content;
     }
 
 
@@ -328,8 +328,8 @@ 
      */
     public function getTemplate($template_reference)
     {
-        return isset($this->jsdata['templates'][ $template_reference ])
-            ? $this->jsdata['templates'][ $template_reference ]
+        return isset($this->jsdata['templates'][$template_reference])
+            ? $this->jsdata['templates'][$template_reference]
             : '';
     }
 
@@ -342,8 +342,8 @@ 
      */
     public function getData($key)
     {
-        return isset($this->jsdata[ $key ])
-            ? $this->jsdata[ $key ]
+        return isset($this->jsdata[$key])
+            ? $this->jsdata[$key]
             : false;
     }
 
@@ -358,11 +358,11 @@ 
      */
     protected function verifyDataNotExisting($key)
     {
-        if (isset($this->jsdata[ $key ])) {
-            if (! $this->debug()) {
+        if (isset($this->jsdata[$key])) {
+            if ( ! $this->debug()) {
                 return false;
             }
-            if (is_array($this->jsdata[ $key ])) {
+            if (is_array($this->jsdata[$key])) {
                 throw new InvalidArgumentException(
                     sprintf(
                         __(
@@ -405,11 +405,11 @@ 
     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][$chunk_name.'.'.$asset_type],
+            $this->manifest_data[$namespace]['url_base']
         )
-            ? $this->manifest_data[ $namespace ]['url_base']
-              . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ]
+            ? $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',
@@ -460,7 +460,7 @@ 
             $this->registerManifestFile(
                 $manifest_file->assetNamespace(),
                 $manifest_file->urlBase(),
-                $manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST
+                $manifest_file->filepath().Registry::FILE_NAME_BUILD_MANIFEST
             );
         }
     }
@@ -478,8 +478,8 @@ 
      */
     public function registerManifestFile($namespace, $url_base, $manifest_file)
     {
-        if (isset($this->manifest_data[ $namespace ])) {
-            if (! $this->debug()) {
+        if (isset($this->manifest_data[$namespace])) {
+            if ( ! $this->debug()) {
                 return;
             }
             throw new InvalidArgumentException(
@@ -512,9 +512,9 @@ 
             }
             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);
+        $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);
         }
     }
 
@@ -529,7 +529,7 @@ 
      */
     private function decodeManifestFile($manifest_file)
     {
-        if (! file_exists($manifest_file)) {
+        if ( ! file_exists($manifest_file)) {
             throw new InvalidFilePathException($manifest_file);
         }
         return json_decode(file_get_contents($manifest_file), true);
@@ -543,7 +543,7 @@ 
      */
     private function addRegisteredScriptHandlesWithData($script_handle)
     {
-        $this->script_handles_with_data[ $script_handle ] = $script_handle;
+        $this->script_handles_with_data[$script_handle] = $script_handle;
     }
 
 
@@ -569,23 +569,23 @@ 
      */
     private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
     {
-        if (isset($this->script_handles_with_data[ $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($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($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']);
+                unset($wp_scripts->registered[$script_handle]->extra['after']);
             }
             if ($unset_handle) {
-                unset($this->script_handles_with_data[ $script_handle ]);
+                unset($this->script_handles_with_data[$script_handle]);
             }
         }
     }

espresso.php

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.78.rc.021');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.78.rc.021');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }

core/db_models/EEM_Payment_Method.model.php

Indentation +359 added lines, -359 removed lines

@@ -20,363 +20,363 @@
 class EEM_Payment_Method extends EEM_Base
 {
 
-    const scope_cart = 'CART';
-
-    const scope_admin = 'ADMIN';
-
-    const scope_api = 'API';
-
-    /**
-     *
-     * @type EEM_Payment_Method
-     */
-    protected static $_instance = null;
-
-
-
-    /**
-     * private constructor to prevent direct creation
-     * @Constructor
-     * @access   protected
-     * @return EEM_Payment_Method
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singlular_item = __('Payment Method', 'event_espresso');
-        $this->plural_item = __('Payment Methods', 'event_espresso');
-        $this->_tables = array( 'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID') );
-        $this->_fields = array(
-            'Payment_Method' => array(
-                'PMD_ID' => new EE_Primary_Key_Int_Field('PMD_ID', __("ID", 'event_espresso')),
-                'PMD_type' => new EE_Plain_Text_Field('PMD_type', __("Payment Method Type", 'event_espresso'), false, 'Admin_Only'),
-                'PMD_name' => new EE_Plain_Text_Field('PMD_name', __("Name", 'event_espresso'), false),
-                'PMD_desc' => new EE_Post_Content_Field('PMD_desc', __("Description", 'event_espresso'), false, ''),
-                'PMD_admin_name' => new EE_Plain_Text_Field('PMD_admin_name', __("Admin-Only Name", 'event_espresso'), true),
-                'PMD_admin_desc' => new EE_Post_Content_Field('PMD_admin_desc', __("Admin-Only Description", 'event_espresso'), true),
-                'PMD_slug' => new EE_Slug_Field('PMD_slug', __("Slug", 'event_espresso'), false),
-                'PMD_order' => new EE_Integer_Field('PMD_order', __("Order", 'event_espresso'), false, 0),
-                'PMD_debug_mode' => new EE_Boolean_Field('PMD_debug_mode', __("Debug Mode On?", 'event_espresso'), false, false),
-                'PMD_wp_user' => new EE_WP_User_Field('PMD_wp_user', __("Payment Method Creator ID", 'event_espresso'), false),
-                'PMD_open_by_default' => new EE_Boolean_Field('PMD_open_by_default', __("Open by Default?", 'event_espresso'), false, false), 'PMD_button_url' => new EE_Plain_Text_Field('PMD_button_url', __("Button URL", 'event_espresso'), true, ''),
-                'PMD_scope' => new EE_Serialized_Text_Field('PMD_scope', __("Usable From?", 'event_espresso'), false, array()), // possible values currently are 'CART','ADMIN','API'
-        ) );
-        $this->_model_relations = array(
-            'Payment' => new EE_Has_Many_Relation(),
-            'Currency' => new EE_HABTM_Relation('Currency_Payment_Method'),
-            'Transaction' => new EE_Has_Many_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-        );
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * Gets one by the slug provided
-     * @param string $slug
-     * @return EE_Payment_Method
-     */
-    public function get_one_by_slug($slug)
-    {
-        return $this->get_one(array( array( 'PMD_slug' => $slug ) ));
-    }
-
-
-
-    /**
-     * Gets all the acceptable scopes for payment methods.
-     * Keys are their names as store din the DB, and values are nice names for displaying them
-     * @return array
-     */
-    public function scopes()
-    {
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__scopes',
-            array(
-                self::scope_cart        => __("Front-end Registration Page", 'event_espresso'),
-                self::scope_admin   => __("Admin Registration Page (no online processing)", 'event_espresso')
-            )
-        );
-    }
-
-
-
-    /**
-     * Determines if this is an valid scope
-     * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
-     * @return boolean
-     */
-    public function is_valid_scope($scope)
-    {
-        $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Gets all active payment methods
-     * @param string $scope one of
-     * @param array  $query_params
-     * @throws EE_Error
-     * @return EE_Payment_Method[]
-     */
-    public function get_all_active($scope = null, $query_params = array())
-    {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
-            $query_params['order_by'] = array( 'PMD_order' => 'ASC', 'PMD_ID' => 'ASC' );
-        }
-        return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-    /**
-     * Counts all active gateways in the specified scope
-     * @param string $scope one of EEM_Payment_Method::scope_*
-     * @param array $query_params
-     * @return int
-     */
-    public function count_active($scope = null, $query_params = array())
-    {
-        return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws EE_Error
-     */
-    protected function _get_query_params_for_all_active($scope = null, $query_params = array())
-    {
-        if ($scope) {
-            if ($this->is_valid_scope($scope)) {
-                return array_replace_recursive(array( array( 'PMD_scope' => array( 'LIKE', "%$scope%" ) ) ), $query_params);
-            } else {
-                throw new EE_Error(sprintf(__("'%s' is not a valid scope for a payment method", "event_espresso"), $scope));
-            }
-        } else {
-            $acceptable_scopes = array();
-            $count = 0;
-            foreach ($this->scopes() as $scope_name => $desc) {
-                $count++;
-                $acceptable_scopes[ 'PMD_scope*' . $count ] = array( 'LIKE', '%' . $scope_name . '%' );
-            }
-            return array_replace_recursive(array( array( 'OR*active_scope' => $acceptable_scopes ) ), $query_params);
-        }
-    }
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws EE_Error
-     */
-    public function get_query_params_for_all_active($scope = null, $query_params = array())
-    {
-        return $this->_get_query_params_for_all_active($scope, $query_params);
-    }
-
-
-    /**
-     * Gets one active payment method. see @get_all_active for documentation
-     * @param string $scope
-     * @param array  $query_params
-     * @return EE_Payment_Method
-     */
-    public function get_one_active($scope = null, $query_params = array())
-    {
-        return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-
-    /**
-     * Gets one payment method of that type, regardless of whether its active or not
-     * @param string $type
-     * @return EE_Payment_Method
-     */
-    public function get_one_of_type($type)
-    {
-        return $this->get_one(array( array( 'PMD_type' => $type ) ));
-    }
-
-
-
-    /**
-     * Overrides parent ot also check by the slug
-     * @see EEM_Base::ensure_is_obj()
-     * @param string|int|EE_Payment_Method $base_class_obj_or_id
-     * @param boolean                      $ensure_is_in_db
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
-    {
-        // first: check if it's a slug
-        if (is_string($base_class_obj_or_id)) {
-            $obj = $this->get_one_by_slug($base_class_obj_or_id);
-            if ($obj) {
-                return $obj;
-            }
-        }
-        // ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
-        try {
-            return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
-        } catch (EE_Error $e) {
-            // handle it outside the catch
-        }
-        throw new EE_Error(sprintf(__("'%s' is neither a Payment Method ID, slug, nor object.", "event_espresso"), $base_class_obj_or_id));
-    }
-
-
-
-    /**
-     * Gets the ID of this object, or if its a string finds the object's id
-     * associated with that slug
-     * @param mixed $base_obj_or_id_or_slug
-     * @return int
-     */
-    public function ensure_is_ID($base_obj_or_id_or_slug)
-    {
-        if (is_string($base_obj_or_id_or_slug)) {
-            // assume it's a slug
-            $base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
-        }
-        return parent::ensure_is_ID($base_obj_or_id_or_slug);
-    }
-
-
-
-    /**
-     * Verifies the button urls on all the passed payment methods have a valid button url. If not, resets them to their default.
-     * @param EE_Payment_Method[] $payment_methods. If NULL is provided defaults to all payment methods active in the cart
-     */
-    public function verify_button_urls($payment_methods = null)
-    {
-        $payment_methods = is_array($payment_methods) ? $payment_methods : $this->get_all_active(EEM_Payment_Method::scope_cart);
-        foreach ($payment_methods as $payment_method) {
-            try {
-                // If there is really no button URL at all, or if the button URLs still point to decaf folder even
-                // though this is a caffeinated install, reset it to the default.
-                $current_button_url = $payment_method->button_url();
-                if (empty($current_button_url)
-                || (
-                        strpos($current_button_url, 'decaf') !== false
-                        && strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
-                    )
-                ) {
-                    $payment_method->save(
-                        [
-                            'PMD_button_url' => $payment_method->type_obj()->default_button_url()
-                        ]
-                    );
-                }
-            } catch (EE_Error $e) {
-                $payment_method->set_active(false);
-            }
-        }
-    }
-
-
-
-    /**
-     * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
-     * but also verifies the payment method type of each is a usable object. If not,
-     * deactivate it, sets a notification, and deactivates it
-     *
-     * @param array $rows
-     * @return EE_Payment_Method[]
-     * @throws InvalidDataTypeException
-     */
-    protected function _create_objects($rows = array())
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $payment_methods = parent::_create_objects($rows);
-        /* @var $payment_methods EE_Payment_Method[] */
-        $usable_payment_methods = array();
-        foreach ($payment_methods as $key => $payment_method) {
-            if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
-                // some payment methods enqueue their scripts in EE_PMT_*::__construct
-                // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
-                // its scripts). but for backwards-compat we should continue to do that
-                $payment_method->type_obj();
-            } elseif ($payment_method->active()) {
-                // only deactivate and notify the admin if the payment is active somewhere
-                $payment_method->deactivate();
-                $payment_method->save();
-                do_action(
-                    'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
-                    $payment_method
-                );
-                new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
-                    sprintf(
-                        __(
-                            'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
-                            'event_espresso'
-                        ),
-                        $payment_method->admin_name(),
-                        '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
-                        '</a>'
-                    ),
-                    true
-                );
-            }
-        }
-        return $usable_payment_methods;
-    }
-
-
-
-    /**
-     * Gets all the payment methods which can be used for transaction
-     * (according to the relations between payment methods and events, and
-     * the currencies used for the transaction and their relation to payment methods)
-     * @param EE_Transaction $transaction
-     * @param string    $scope @see EEM_Payment_Method::get_all_for_events
-     * @return EE_Payment_Method[]
-     */
-    public function get_all_for_transaction($transaction, $scope)
-    {
-        // give addons a chance to override what payment methods are chosen based on the transaction
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-            $this->get_all_active($scope, array( 'group_by' => 'PMD_type' )),
-            $transaction,
-            $scope
-        );
-    }
-
-
-    /**
-     * Returns the payment method used for the last payment made for a registration.
-     *
-     * Note: if an offline payment method was selected on the related transaction then this will have no payment methods returned.
-     * It will ONLY return a payment method for a PAYMENT recorded against the registration.
-     *
-     * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
-     * @return EE_Payment|null
-     */
-    public function get_last_used_for_registration($registration_or_reg_id)
-    {
-        $registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
-
-        $query_params = array(
-            0 => array(
-                'Payment.Registration.REG_ID' => $registration_id,
-            ),
-            'order_by' => array( 'Payment.PAY_ID' => 'DESC' )
-        );
-        return $this->get_one($query_params);
-    }
+	const scope_cart = 'CART';
+
+	const scope_admin = 'ADMIN';
+
+	const scope_api = 'API';
+
+	/**
+	 *
+	 * @type EEM_Payment_Method
+	 */
+	protected static $_instance = null;
+
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 * @Constructor
+	 * @access   protected
+	 * @return EEM_Payment_Method
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singlular_item = __('Payment Method', 'event_espresso');
+		$this->plural_item = __('Payment Methods', 'event_espresso');
+		$this->_tables = array( 'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID') );
+		$this->_fields = array(
+			'Payment_Method' => array(
+				'PMD_ID' => new EE_Primary_Key_Int_Field('PMD_ID', __("ID", 'event_espresso')),
+				'PMD_type' => new EE_Plain_Text_Field('PMD_type', __("Payment Method Type", 'event_espresso'), false, 'Admin_Only'),
+				'PMD_name' => new EE_Plain_Text_Field('PMD_name', __("Name", 'event_espresso'), false),
+				'PMD_desc' => new EE_Post_Content_Field('PMD_desc', __("Description", 'event_espresso'), false, ''),
+				'PMD_admin_name' => new EE_Plain_Text_Field('PMD_admin_name', __("Admin-Only Name", 'event_espresso'), true),
+				'PMD_admin_desc' => new EE_Post_Content_Field('PMD_admin_desc', __("Admin-Only Description", 'event_espresso'), true),
+				'PMD_slug' => new EE_Slug_Field('PMD_slug', __("Slug", 'event_espresso'), false),
+				'PMD_order' => new EE_Integer_Field('PMD_order', __("Order", 'event_espresso'), false, 0),
+				'PMD_debug_mode' => new EE_Boolean_Field('PMD_debug_mode', __("Debug Mode On?", 'event_espresso'), false, false),
+				'PMD_wp_user' => new EE_WP_User_Field('PMD_wp_user', __("Payment Method Creator ID", 'event_espresso'), false),
+				'PMD_open_by_default' => new EE_Boolean_Field('PMD_open_by_default', __("Open by Default?", 'event_espresso'), false, false), 'PMD_button_url' => new EE_Plain_Text_Field('PMD_button_url', __("Button URL", 'event_espresso'), true, ''),
+				'PMD_scope' => new EE_Serialized_Text_Field('PMD_scope', __("Usable From?", 'event_espresso'), false, array()), // possible values currently are 'CART','ADMIN','API'
+		) );
+		$this->_model_relations = array(
+			'Payment' => new EE_Has_Many_Relation(),
+			'Currency' => new EE_HABTM_Relation('Currency_Payment_Method'),
+			'Transaction' => new EE_Has_Many_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+		);
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * Gets one by the slug provided
+	 * @param string $slug
+	 * @return EE_Payment_Method
+	 */
+	public function get_one_by_slug($slug)
+	{
+		return $this->get_one(array( array( 'PMD_slug' => $slug ) ));
+	}
+
+
+
+	/**
+	 * Gets all the acceptable scopes for payment methods.
+	 * Keys are their names as store din the DB, and values are nice names for displaying them
+	 * @return array
+	 */
+	public function scopes()
+	{
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__scopes',
+			array(
+				self::scope_cart        => __("Front-end Registration Page", 'event_espresso'),
+				self::scope_admin   => __("Admin Registration Page (no online processing)", 'event_espresso')
+			)
+		);
+	}
+
+
+
+	/**
+	 * Determines if this is an valid scope
+	 * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
+	 * @return boolean
+	 */
+	public function is_valid_scope($scope)
+	{
+		$scopes = $this->scopes();
+		if (isset($scopes[ $scope ])) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Gets all active payment methods
+	 * @param string $scope one of
+	 * @param array  $query_params
+	 * @throws EE_Error
+	 * @return EE_Payment_Method[]
+	 */
+	public function get_all_active($scope = null, $query_params = array())
+	{
+		if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+			$query_params['order_by'] = array( 'PMD_order' => 'ASC', 'PMD_ID' => 'ASC' );
+		}
+		return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+	/**
+	 * Counts all active gateways in the specified scope
+	 * @param string $scope one of EEM_Payment_Method::scope_*
+	 * @param array $query_params
+	 * @return int
+	 */
+	public function count_active($scope = null, $query_params = array())
+	{
+		return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws EE_Error
+	 */
+	protected function _get_query_params_for_all_active($scope = null, $query_params = array())
+	{
+		if ($scope) {
+			if ($this->is_valid_scope($scope)) {
+				return array_replace_recursive(array( array( 'PMD_scope' => array( 'LIKE', "%$scope%" ) ) ), $query_params);
+			} else {
+				throw new EE_Error(sprintf(__("'%s' is not a valid scope for a payment method", "event_espresso"), $scope));
+			}
+		} else {
+			$acceptable_scopes = array();
+			$count = 0;
+			foreach ($this->scopes() as $scope_name => $desc) {
+				$count++;
+				$acceptable_scopes[ 'PMD_scope*' . $count ] = array( 'LIKE', '%' . $scope_name . '%' );
+			}
+			return array_replace_recursive(array( array( 'OR*active_scope' => $acceptable_scopes ) ), $query_params);
+		}
+	}
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws EE_Error
+	 */
+	public function get_query_params_for_all_active($scope = null, $query_params = array())
+	{
+		return $this->_get_query_params_for_all_active($scope, $query_params);
+	}
+
+
+	/**
+	 * Gets one active payment method. see @get_all_active for documentation
+	 * @param string $scope
+	 * @param array  $query_params
+	 * @return EE_Payment_Method
+	 */
+	public function get_one_active($scope = null, $query_params = array())
+	{
+		return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+
+	/**
+	 * Gets one payment method of that type, regardless of whether its active or not
+	 * @param string $type
+	 * @return EE_Payment_Method
+	 */
+	public function get_one_of_type($type)
+	{
+		return $this->get_one(array( array( 'PMD_type' => $type ) ));
+	}
+
+
+
+	/**
+	 * Overrides parent ot also check by the slug
+	 * @see EEM_Base::ensure_is_obj()
+	 * @param string|int|EE_Payment_Method $base_class_obj_or_id
+	 * @param boolean                      $ensure_is_in_db
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
+	{
+		// first: check if it's a slug
+		if (is_string($base_class_obj_or_id)) {
+			$obj = $this->get_one_by_slug($base_class_obj_or_id);
+			if ($obj) {
+				return $obj;
+			}
+		}
+		// ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
+		try {
+			return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
+		} catch (EE_Error $e) {
+			// handle it outside the catch
+		}
+		throw new EE_Error(sprintf(__("'%s' is neither a Payment Method ID, slug, nor object.", "event_espresso"), $base_class_obj_or_id));
+	}
+
+
+
+	/**
+	 * Gets the ID of this object, or if its a string finds the object's id
+	 * associated with that slug
+	 * @param mixed $base_obj_or_id_or_slug
+	 * @return int
+	 */
+	public function ensure_is_ID($base_obj_or_id_or_slug)
+	{
+		if (is_string($base_obj_or_id_or_slug)) {
+			// assume it's a slug
+			$base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
+		}
+		return parent::ensure_is_ID($base_obj_or_id_or_slug);
+	}
+
+
+
+	/**
+	 * Verifies the button urls on all the passed payment methods have a valid button url. If not, resets them to their default.
+	 * @param EE_Payment_Method[] $payment_methods. If NULL is provided defaults to all payment methods active in the cart
+	 */
+	public function verify_button_urls($payment_methods = null)
+	{
+		$payment_methods = is_array($payment_methods) ? $payment_methods : $this->get_all_active(EEM_Payment_Method::scope_cart);
+		foreach ($payment_methods as $payment_method) {
+			try {
+				// If there is really no button URL at all, or if the button URLs still point to decaf folder even
+				// though this is a caffeinated install, reset it to the default.
+				$current_button_url = $payment_method->button_url();
+				if (empty($current_button_url)
+				|| (
+						strpos($current_button_url, 'decaf') !== false
+						&& strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
+					)
+				) {
+					$payment_method->save(
+						[
+							'PMD_button_url' => $payment_method->type_obj()->default_button_url()
+						]
+					);
+				}
+			} catch (EE_Error $e) {
+				$payment_method->set_active(false);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
+	 * but also verifies the payment method type of each is a usable object. If not,
+	 * deactivate it, sets a notification, and deactivates it
+	 *
+	 * @param array $rows
+	 * @return EE_Payment_Method[]
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _create_objects($rows = array())
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_methods = parent::_create_objects($rows);
+		/* @var $payment_methods EE_Payment_Method[] */
+		$usable_payment_methods = array();
+		foreach ($payment_methods as $key => $payment_method) {
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
+				$usable_payment_methods[ $key ] = $payment_method;
+				// some payment methods enqueue their scripts in EE_PMT_*::__construct
+				// which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
+				// its scripts). but for backwards-compat we should continue to do that
+				$payment_method->type_obj();
+			} elseif ($payment_method->active()) {
+				// only deactivate and notify the admin if the payment is active somewhere
+				$payment_method->deactivate();
+				$payment_method->save();
+				do_action(
+					'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
+					$payment_method
+				);
+				new PersistentAdminNotice(
+					'auto-deactivated-' . $payment_method->type(),
+					sprintf(
+						__(
+							'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
+							'event_espresso'
+						),
+						$payment_method->admin_name(),
+						'<br />',
+						'<a href="' . admin_url('plugins.php') . '">',
+						'</a>'
+					),
+					true
+				);
+			}
+		}
+		return $usable_payment_methods;
+	}
+
+
+
+	/**
+	 * Gets all the payment methods which can be used for transaction
+	 * (according to the relations between payment methods and events, and
+	 * the currencies used for the transaction and their relation to payment methods)
+	 * @param EE_Transaction $transaction
+	 * @param string    $scope @see EEM_Payment_Method::get_all_for_events
+	 * @return EE_Payment_Method[]
+	 */
+	public function get_all_for_transaction($transaction, $scope)
+	{
+		// give addons a chance to override what payment methods are chosen based on the transaction
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
+			$this->get_all_active($scope, array( 'group_by' => 'PMD_type' )),
+			$transaction,
+			$scope
+		);
+	}
+
+
+	/**
+	 * Returns the payment method used for the last payment made for a registration.
+	 *
+	 * Note: if an offline payment method was selected on the related transaction then this will have no payment methods returned.
+	 * It will ONLY return a payment method for a PAYMENT recorded against the registration.
+	 *
+	 * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
+	 * @return EE_Payment|null
+	 */
+	public function get_last_used_for_registration($registration_or_reg_id)
+	{
+		$registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
+
+		$query_params = array(
+			0 => array(
+				'Payment.Registration.REG_ID' => $registration_id,
+			),
+			'order_by' => array( 'Payment.PAY_ID' => 'DESC' )
+		);
+		return $this->get_one($query_params);
+	}
 }