ischenko/yii2-jsloader

<?php
/**
 * @copyright Copyright (c) 2016 Roman Ishchenko
 * @license https://github.com/ischenko/yii2-jsloader/blob/master/LICENSE
 * @link https://github.com/ischenko/yii2-jsloader#readme
 */

namespace ischenko\yii2\jsloader;

use yii\base\InvalidArgumentException;
use yii\base\InvalidConfigException;
use yii\web\View;

/**
 * The Behavior is used to process asset bundles registered within a view.
 *
 * It listens two events:
 *  - [[\yii\web\View::EVENT_END_BODY]] used to register an asset bundles from the view in the JS loader
 *  - [[\yii\web\View::EVENT_END_PAGE]] used to process other assets registered in the view and perform bootstrap of the JS loader
 *
 * @author Roman Ishchenko <roman@ishchenko.ck.ua>
 * @since 1.0
 *
 * @property View $owner
 */
class Behavior extends \yii\base\Behavior
{
    /**
     * @var LoaderInterface|array
     */
    private $loader = [];

    /**
     * @inheritdoc
     */
    public function events()
    {
        return [
            View::EVENT_END_PAGE => 'processAssets',
            View::EVENT_END_BODY => 'processBundles'
        ];
    }

    /**
     * Starts processing of assets by the loader
     */
    public function processAssets()
    {
        $this->getLoader()->processAssets();
    }

    /**
     * Registers asset bundles in the JS loader
     */
    public function processBundles()
    {
        $this->getLoader()->processBundles();
    }

    /**
     * @return LoaderInterface
     *
     * @throws InvalidConfigException
     */
    public function getLoader()
    {
        if (is_array($this->loader)) {
            $this->loader = \Yii::createObject($this->loader, [$this->ensureView($this->owner)]);
        }

        if (!($this->loader instanceof LoaderInterface)) {
            throw new InvalidConfigException('Unable to instantiate new loader please check configuration');
        }

        return $this->loader;
    }

    /**
     * @param LoaderInterface|array $loader
     *
     * @throws InvalidArgumentException
     */
    public function setLoader($loader)
    {
        if (!is_array($loader) && !($loader instanceof LoaderInterface)) {
            throw new InvalidArgumentException('Argument should be an array or implement LoaderInterface');
        }

        $this->loader = $loader;
    }

    /**
     * Ensures that passed object is an instance of \yii\web\View
     *
     * @param mixed $object
     *
     * @return View
     * @throws InvalidConfigException
     */
    protected function ensureView($object)
    {
        if (!($object instanceof View)) {
            $message = '"yii\web\View" instance expected';

            if (is_object($object)) {
                $message .= ', got "' . get_class($object) . '"';
            }

            throw new InvalidConfigException($message);
        }

        return $object;
    }
}