Booster.php

Go to the documentation of this file.

<?php
class Booster extends CApplicationComponent {
        
        public $enableCdn = false;

        public $coreCss = true;

        public $bootstrapCss = true;

        public $responsiveCss = true;
        
        public $disableZooming = false;

        public $fontAwesomeCss = false;

        public $minify = true;

        public $yiiCss = true;

        public $jqueryCss = true;

        public $enableJS = true;

        public $enableBootboxJS = true;

        public $enableNotifierJS = true;

        public $ajaxCssLoad = false;

        public $ajaxJsLoad = false;

        public $forceCopyAssets = false;
        
        public $enablePopover = true;
        
        public $enableTooltip = true;

        public $popoverSelector = '[data-toggle=popover]';

        public $tooltipSelector = '[data-toggle=tooltip]';

        public $packages = array();

        public $cs;

        public $_assetsUrl;

    private static $_instance;

        public function init() {
                
                // Prevents the extension from registering scripts and publishing assets when ran from the command line.
                if ($this->isInConsoleMode() && !$this->isInTests())
                        return;

        self::setBooster($this);

        $this->setRootAliasIfUndefined();

                $this->setAssetsRegistryIfNotDefined();

                $this->includeAssets();

                parent::init();
        }

        protected function isInConsoleMode() {
                
                return Yii::app() instanceof CConsoleApplication || PHP_SAPI == 'cli';
        }

        protected function isInTests() {
                
                return defined('IS_IN_TESTS') && IS_IN_TESTS;
        }

        protected function setRootAliasIfUndefined() {
                
                if (Yii::getPathOfAlias('booster') === false) {
                        Yii::setPathOfAlias('booster', realpath(dirname(__FILE__) . '/..'));
                }
        }

        protected function includeAssets() {
                
                $this->appendUserSuppliedPackagesToOurs();

                $this->addOurPackagesToYii();

                $this->registerCssPackagesIfEnabled();

                $this->registerJsPackagesIfEnabled();
        }

        protected function appendUserSuppliedPackagesToOurs() {
                
                $bootstrapPackages = require(Yii::getPathOfAlias('booster.components') . '/packages.php');
                $bootstrapPackages += $this->createBootstrapCssPackage();
                $bootstrapPackages += $this->createSelect2Package();

                $this->packages = CMap::mergeArray(
                        $bootstrapPackages,
                        $this->packages
                );
        }

        protected function addOurPackagesToYii() {
                
                foreach ($this->packages as $name => $definition) {
                        $this->cs->addPackage($name, $definition);
                }
        $this->cs->scriptMap['jquery-ui.min.js'] = $this->getAssetsUrl() . '/js/jquery-ui-no-conflict.min.js';
        }

        protected function registerCssPackagesIfEnabled() {
                
                if (!$this->coreCss)
                        return;

                if (!$this->ajaxCssLoad && Yii::app()->request->isAjaxRequest)
                        return;

                if ($this->bootstrapCss)
                        $this->registerBootstrapCss();

                if ($this->fontAwesomeCss)
                        $this->registerFontAwesomeCss();

                if ($this->responsiveCss)
                        $this->registerMetadataForResponsive();

                if ($this->yiiCss !== false)
                        $this->registerYiiCss();

                if ($this->jqueryCss !== false)
                        $this->registerJQueryCss();
        }

        public function registerYiiCss() {
                
                $this->registerPackage('bootstrap-yii');
        }

        public function registerJQueryCss() {
                
                $this->registerPackage('jquery-css')->scriptMap['jquery-ui.css'] = $this->getAssetsUrl(
                ) . '/css/jquery-ui-bootstrap.css';
        }

        protected function registerJsPackagesIfEnabled() {
                
                if (!$this->enableJS)
                        return;

                if (!$this->ajaxJsLoad && Yii::app()->request->isAjaxRequest)
                        return;

                $this->registerPackage('bootstrap.js');
        $this->registerPackage('bootstrap-noconflict');

                if ($this->enableBootboxJS)
                        $this->registerPackage('bootbox');

                if ($this->enableNotifierJS)
                        $this->registerPackage('notify');
                
                if($this->enablePopover)
                        $this->registerPopoverJs();
                
                if($this->enableTooltip)
                        $this->registerTooltipJs();
        }


        public function getVersion() {
                
                return '4.0.1';
        }

        public function registerPackage($name) {
                
                return $this->cs->registerPackage($name);
        }

        public function registerAssetCss($name, $media = '') {
                
                $this->cs->registerCssFile($this->getAssetsUrl() . "/css/{$name}", $media);
        }

        public function registerAssetJs($name, $position = CClientScript::POS_END) {
                
                $this->cs->registerScriptFile($this->getAssetsUrl() . "/js/{$name}", $position);
        }

        public function getAssetsUrl() {
                
                if (isset($this->_assetsUrl)) {
                        return $this->_assetsUrl;
                } else {
                        return $this->_assetsUrl = Yii::app()->getAssetManager()->publish(Yii::getPathOfAlias('booster.assets'), false, -1, $this->forceCopyAssets);
                }
        }

        protected function setAssetsRegistryIfNotDefined() {
                
                if (!$this->cs) {
            $this->cs = Yii::app()->getClientScript();
        }
        }

        public function registerBootstrapCss() {
                
                $this->cs->registerPackage('bootstrap.css');
        }

        protected function createBootstrapCssPackage() {
                
                return array('bootstrap.css' => array(
                        'baseUrl' => $this->enableCdn ? '//netdna.bootstrapcdn.com/bootstrap/3.1.1/' : $this->getAssetsUrl() . '/bootstrap/',
                        'css' => array( ($this->minify || $this->enableCdn) ? 'css/bootstrap.min.css' : 'css/bootstrap.css' ),
                ));
        }

        protected function createSelect2Package() {
                
                $jsFiles = array($this->minify ? 'select2.min.js' : 'select2.js');

                if (strpos(Yii::app()->language, 'en') !== 0) {
                        $locale = 'select2_locale_'. substr(Yii::app()->language, 0, 2). '.js';
                        if (@file_exists(Yii::getPathOfAlias('booster.assets.select2') . DIRECTORY_SEPARATOR . $locale )) {
                                $jsFiles[] = $locale;
                        } else {
                                $locale = 'select2_locale_'. Yii::app()->language . '.js';
                                if (@file_exists(Yii::getPathOfAlias('booster.assets.select2') . DIRECTORY_SEPARATOR . $locale )) {
                                        $jsFiles[] = $locale;
                                }else{
                                        $locale = 'select2_locale_'. substr(Yii::app()->language, 0, 2) . '-' . strtoupper(substr(Yii::app()->language, 3, 2)) . '.js';
                                        if (@file_exists(Yii::getPathOfAlias('booster.assets.select2') . DIRECTORY_SEPARATOR . $locale )) {
                                                $jsFiles[] = $locale;
                                        }
                                }
                        }
                }

                return array('select2' => array(
                        'baseUrl' => $this->getAssetsUrl() . '/select2/',
                        'js' => $jsFiles,
                        'css' => array('select2.css', 'select2-bootstrap.css'),
                        'depends' => array('jquery'),
                ));
        }

        protected function registerMetadataForResponsive() {
                if($this->disableZooming)
                        $this->cs->registerMetaTag('width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no', 'viewport');
                else
                        $this->cs->registerMetaTag('width=device-width, initial-scale=1', 'viewport');
        }

        public function registerFontAwesomeCss() {
                
        $this->registerPackage('font-awesome');
        }
        
        public function registerPopoverJs() {
                $this->cs->registerScript($this->getUniqueScriptId(), "jQuery('[data-toggle=popover]').popover();");
        }
        
        public function registerTooltipJs() {
                $this->cs->registerScript($this->getUniqueScriptId(), "jQuery('[data-toggle=tooltip]').tooltip();");
        }

        public function getUniqueScriptId() {
                return uniqid(__CLASS__ . '#', true);
        }

        protected function tryGetSelectorForPlugin($name) {
                
                return $this->tryGetInfoForPlugin($name, 'selector');
        }

        protected function tryGetOptionsForPlugin($name) {
                
                return $this->tryGetInfoForPlugin($name, 'options');
        }

    public static function setBooster($value) {
        
        if ($value instanceof Booster) {
            self::$_instance = $value;
        }
    }

    public static function getBooster() {
        
        if (null === self::$_instance) {
            // Lets find inside current module
            $module = Yii::app()->getController()->getModule();
            if ($module) {
                if ($module->hasComponent('booster')) {
                    self::$_instance = $module->getComponent('booster');
                }
            }
            // Still nothing?
            if (null === self::$_instance) {
                if (Yii::app()->hasComponent('booster')) {
                    self::$_instance = Yii::app()->getComponent('booster');
                }
            }
        }
        return self::$_instance;
    }
}