/backend/protected/extensions/bootstrap/components/Bootstrap.php
PHP | 471 lines | 198 code | 52 blank | 221 comment | 15 complexity | 6f7899220791a1775882bdd2184d712a MD5 | raw file
- <?php
- /**
- * Bootstrap class file.
- * @author Christoffer Niska <ChristofferNiska@gmail.com>
- * @copyright Copyright © Christoffer Niska 2011-
- * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
- * @version 1.0.0
- */
- /**
- * Bootstrap application component.
- */
- class Bootstrap extends CApplicationComponent
- {
- // Bootstrap plugins.
- const PLUGIN_ALERT = 'alert';
- const PLUGIN_BUTTON = 'button';
- const PLUGIN_CAROUSEL = 'carousel';
- const PLUGIN_COLLAPSE = 'collapse';
- const PLUGIN_DROPDOWN = 'dropdown';
- const PLUGIN_MODAL = 'modal';
- const PLUGIN_POPOVER = 'popover';
- const PLUGIN_SCROLLSPY = 'scrollspy';
- const PLUGIN_TAB = 'tab';
- const PLUGIN_TOOLTIP = 'tooltip';
- const PLUGIN_TRANSITION = 'transition';
- const PLUGIN_TYPEAHEAD = 'typeahead';
- const PLUGIN_DATEPICKER = 'bdatepicker';
- const PLUGIN_REDACTOR = 'redactor';
- const PLUGIN_MARKDOWNEDITOR = 'markdowneditor';
- const PLUGIN_AFFIX = 'affix';
- const PLUGIN_DATERANGEPICKER = 'daterangepicker';
- const PLUGIN_HTML5EDITOR = 'wysihtml5';
- const PLUGIN_COLORPICKER = 'colorpicker';
- /**
- * @var boolean whether to register the Bootstrap core CSS (bootstrap.min.css).
- * Defaults to true.
- */
- public $coreCss = true;
- /**
- * @var boolean whether to register the Bootstrap responsive CSS (bootstrap-responsive.min.css).
- * Defaults to false.
- */
- public $responsiveCss = false;
- /**
- * @var boolean whether to register the Yii-specific CSS missing from Bootstrap.
- * @since 0.9.12
- */
- public $yiiCss = true;
- /**
- * @var boolean whether to register the JQuery-specific CSS missing from Bootstrap.
- */
- public $jqueryCss = true;
- /**
- * @var boolean whether to register jQuery and the Bootstrap JavaScript.
- * @since 0.9.10
- */
- public $enableJS = true;
- /**
- * @var array plugin initial options (name=>options).
- * Each array key-value pair represents the initial options for a single plugin class,
- * with the array key being the plugin name, and array value being the initial options array.
- * @since 0.9.8
- */
- public $plugins = array();
- /**
- * @var string default popover CSS selector.
- * @since 0.10.0
- */
- public $popoverSelector = 'a[rel="popover"]';
- /**
- * @var string default tooltip CSS selector.
- * @since 0.10.0
- */
- public $tooltipSelector = 'a[rel="tooltip"]';
- /**
- * @var bool whether to enable bootbox messages or not. Default value is true.
- * @since YiiBooster 1.0.5
- */
- public $enableBootboxJS = true;
- protected $_assetsUrl;
- /**
- * Initializes the component.
- */
- public function init()
- {
- // Register the bootstrap path alias.
- if (Yii::getPathOfAlias('bootstrap') === false)
- Yii::setPathOfAlias('bootstrap', realpath(dirname(__FILE__) . '/..'));
- // Prevents the extension from registering scripts and publishing assets when ran from the command line.
- if (Yii::app() instanceof CConsoleApplication)
- return;
- if ($this->coreCss !== false)
- $this->registerCoreCss();
- if ($this->responsiveCss !== false)
- $this->registerResponsiveCss();
- if ($this->yiiCss !== false)
- $this->registerYiiCss();
- if($this->jqueryCss !== false)
- $this->registerJQueryCss();
- if ($this->enableJS !== false)
- $this->registerCoreScripts();
- parent::init();
- }
- /**
- * Registers the Bootstrap CSS.
- */
- public function registerCoreCss()
- {
- $this->registerAssetCss('bootstrap' . (!YII_DEBUG ? '.min' : '') . '.css');
- }
- /**
- * Registers the Bootstrap responsive CSS.
- * @since 0.9.8
- */
- public function registerResponsiveCss()
- {
- /** @var CClientScript $cs */
- $cs = Yii::app()->getClientScript();
- $cs->registerMetaTag('width=device-width, initial-scale=1.0', 'viewport');
- $cs->registerCssFile($this->getAssetsUrl() . '/css/bootstrap-responsive' . (!YII_DEBUG ? '.min' : '') . '.css');
- }
- /**
- * Registers the Yii-specific CSS missing from Bootstrap.
- * @since 0.9.11
- */
- public function registerYiiCss()
- {
- $this->registerAssetCss('bootstrap-yii.css');
- }
- /**
- * Registers the JQuery-specific CSS missing from Bootstrap.
- */
- public function registerJQueryCss()
- {
- Yii::app()->getClientScript()->scriptMap['jquery-ui.css'] = $this->getAssetsUrl() . '/css/jquery-ui-bootstrap.css';
- $this->registerAssetCss('jquery-ui-bootstrap.css');
- }
- /**
- * Registers a specific css in the asset's css folder
- * @param string $cssFile the css file name to register
- * @param string $media the media that the CSS file should be applied to. If empty, it means all media types.
- */
- public function registerAssetCss($cssFile, $media = '')
- {
- Yii::app()->getClientScript()->registerCssFile($this->getAssetsUrl() . "/css/{$cssFile}", $media);
- }
- /**
- * Registers the core JavaScript.
- * @since 0.9.8
- */
- public function registerCoreScripts()
- {
- $this->registerJS(Yii::app()->clientScript->coreScriptPosition);
- $this->registerTooltip();
- $this->registerPopover();
- }
- /**
- * Registers the Bootstrap JavaScript.
- * @param int $position the position of the JavaScript code.
- * @see CClientScript::registerScriptFile
- */
- public function registerJS($position = CClientScript::POS_HEAD)
- {
- /** @var CClientScript $cs */
- $cs = Yii::app()->getClientScript();
- $cs->registerCoreScript('jquery');
- /** enable bootboxJS? */
- if($this->enableBootboxJS)
- {
- $cs->registerScriptFile($this->getAssetsUrl() . '/js/bootstrap.bootbox.min.js', $position);
- }
- $cs->registerScriptFile($this->getAssetsUrl() . '/js/bootstrap' . (!YII_DEBUG ? '.min' : '') . '.js', $position);
- }
- /**
- * Register a specific js file in the asset's js folder
- * @param string $jsFile
- * @param int $position the position of the JavaScript code.
- * @see CClientScript::registerScriptFile
- */
- public function registerAssetJs($jsFile, $position = CClientScript::POS_END)
- {
- Yii::app()->getClientScript()->registerScriptFile($this->getAssetsUrl() . "/js/{$jsFile}", $position);
- }
- /**
- * Registers the Bootstrap alert plugin.
- * @param string $selector the CSS selector
- * @param array $options the plugin options
- * @see http://twitter.github.com/bootstrap/javascript.html#alerts
- * @since 0.9.8
- */
- public function registerAlert($selector = null, $options = array())
- {
- $this->registerPlugin(self::PLUGIN_ALERT, $selector, $options);
- }
- /**
- * Registers the Bootstrap buttons plugin.
- * @param string $selector the CSS selector
- * @param array $options the plugin options
- * @see http://twitter.github.com/bootstrap/javascript.html#buttons
- * @since 0.9.8
- */
- public function registerButton($selector = null, $options = array())
- {
- $this->registerPlugin(self::PLUGIN_BUTTON, $selector, $options);
- }
- /**
- * Registers the Bootstrap carousel plugin.
- * @param string $selector the CSS selector
- * @param array $options the plugin options
- * @see http://twitter.github.com/bootstrap/javascript.html#carousel
- * @since 0.9.8
- */
- public function registerCarousel($selector = null, $options = array())
- {
- $this->registerPlugin(self::PLUGIN_CAROUSEL, $selector, $options);
- }
- /**
- * Registers the Bootstrap collapse plugin.
- * @param string $selector the CSS selector
- * @param array $options the plugin options
- * @see http://twitter.github.com/bootstrap/javascript.html#collapse
- * @since 0.9.8
- */
- public function registerCollapse($selector = null, $options = array())
- {
- $this->registerPlugin(self::PLUGIN_COLLAPSE, $selector, $options, '.collapse');
- }
- /**
- * Registers the Bootstrap dropdowns plugin.
- * @param string $selector the CSS selector
- * @param array $options the plugin options
- * @see http://twitter.github.com/bootstrap/javascript.html#dropdowns
- * @since 0.9.8
- */
- public function registerDropdown($selector = null, $options = array())
- {
- $this->registerPlugin(self::PLUGIN_DROPDOWN, $selector, $options, '.dropdown-toggle[data-dropdown="dropdown"]');
- }
- /**
- * Registers the Bootstrap modal plugin.
- * @param string $selector the CSS selector
- * @param array $options the plugin options
- * @see http://twitter.github.com/bootstrap/javascript.html#modal
- * @since 0.9.8
- */
- public function registerModal($selector = null, $options = array())
- {
- $this->registerPlugin(self::PLUGIN_MODAL, $selector, $options);
- }
- /**
- * Registers the Bootstrap scrollspy plugin.
- * @param string $selector the CSS selector
- * @param array $options the plugin options
- * @see http://twitter.github.com/bootstrap/javascript.html#scrollspy
- * @since 0.9.8
- */
- public function registerScrollSpy($selector = null, $options = array())
- {
- $this->registerPlugin(self::PLUGIN_SCROLLSPY, $selector, $options);
- }
- /**
- * Registers the Bootstrap popover plugin.
- * @param string $selector the CSS selector
- * @param array $options the plugin options
- * @see http://twitter.github.com/bootstrap/javascript.html#popover
- * @since 0.9.8
- */
- public function registerPopover($selector = null, $options = array())
- {
- $this->registerTooltip(); // Popover requires the tooltip plugin
- $this->registerPlugin(self::PLUGIN_POPOVER, $selector, $options, $this->popoverSelector);
- }
- /**
- * Registers the Bootstrap tabs plugin.
- * @param string $selector the CSS selector
- * @param array $options the plugin options
- * @see http://twitter.github.com/bootstrap/javascript.html#tabs
- * @since 0.9.8
- */
- public function registerTabs($selector = null, $options = array())
- {
- $this->registerPlugin(self::PLUGIN_TAB, $selector, $options);
- }
- /**
- * Registers the Bootstrap tooltip plugin.
- * @param string $selector the CSS selector
- * @param array $options the plugin options
- * @see http://twitter.github.com/bootstrap/javascript.html#tooltip
- * @since 0.9.8
- */
- public function registerTooltip($selector = null, $options = array())
- {
- $this->registerPlugin(self::PLUGIN_TOOLTIP, $selector, $options, $this->tooltipSelector);
- }
- /**
- * Registers the Bootstrap typeahead plugin.
- * @param string $selector the CSS selector
- * @param array $options the plugin options
- * @see http://twitter.github.com/bootstrap/javascript.html#typeahead
- * @since 0.9.8
- */
- public function registerTypeahead($selector = null, $options = array())
- {
- $this->registerPlugin(self::PLUGIN_TYPEAHEAD, $selector, $options);
- }
- /**
- * Register the Bootstrap datepicker plugin.
- * IMPORTANT: if you register a selector via this method you wont be able to attach events to the plugin.
- * @param string $selector the CSS selector
- * @param array $options the plugin options
- * @see http://www.eyecon.ro/bootstrap-datepicker/
- *
- */
- public function registerDatePicker($selector = null, $options = array())
- {
- $this->registerPlugin(self::PLUGIN_DATEPICKER, $selector, $options);
- }
- /**
- * Registers the RedactorJS plugin.
- * @param null $selector
- * @param $options
- */
- public function registerRedactor($selector = null, $options = array())
- {
- $this->registerPlugin(self::PLUGIN_REDACTOR, $selector, $options);
- }
- /**
- * Registers the Bootstrap-whysihtml5 plugin.
- * @param null $selector
- * @param $options
- */
- public function registerHtml5Editor($selector = null, $options = array())
- {
- $this->registerPlugin(self::PLUGIN_HTML5EDITOR, $selector, $options);
- }
- /**
- * Registers the Bootstrap-colorpicker plugin.
- * @param null $selector
- * @param $options
- */
- public function registerColorPicker($selector = null, $options = array())
- {
- $this->registerPlugin(self::PLUGIN_COLORPICKER, $selector, $options);
- }
- /**
- * Registers the affix plugin
- * @param null $selector
- * @param array $options
- * @see http://twitter.github.com/bootstrap/javascript.html#affix
- */
- public function registerAffix($selector = null, $options = array())
- {
- $this->registerPlugin(self::PLUGIN_AFFIX, $selector, $options);
- }
- /**
- * Registers the Bootstrap daterange plugin
- * @param string $selector the CSS selector
- * @param array $options the plugin options
- * @param $callback the javascript callback function
- * @see http://www.dangrossman.info/2012/08/20/a-date-range-picker-for-twitter-bootstrap/
- * @since 1.1.0
- */
- public function registerDateRangePlugin($selector, $options = array(), $callback = null)
- {
- $key = __CLASS__ . '.' . md5(self::PLUGIN_DATERANGEPICKER . $selector . serialize($options) . $callback);
- Yii::app()->clientScript->registerScript($key, '$("' . $selector . '").daterangepicker(' . CJavaScript::encode($options) . ($callback ? ', ' . CJavaScript::encode($callback) : '') . ');');
- }
- /**
- * Registers a Bootstrap JavaScript plugin.
- * @param string $name the name of the plugin
- * @param string $selector the CSS selector
- * @param array $options the plugin options
- * @param string $defaultSelector the default CSS selector
- * @since 0.9.8
- */
- protected function registerPlugin($name, $selector = null, $options = array(), $defaultSelector = null)
- {
- if (!isset($selector) && empty($options))
- {
- // Initialization from extension configuration.
- $config = isset($this->plugins[$name]) ? $this->plugins[$name] : array();
- if (isset($config['selector']))
- $selector = $config['selector'];
- if (isset($config['options']))
- $options = $config['options'];
- if (!isset($selector))
- $selector = $defaultSelector;
- }
- if (isset($selector))
- {
- $key = __CLASS__ . '.' . md5($name . $selector . serialize($options) . $defaultSelector);
- $options = !empty($options) ? CJavaScript::encode($options) : '';
- Yii::app()->clientScript->registerScript($key, "jQuery('{$selector}').{$name}({$options});");
- }
- }
- /**
- * Returns the URL to the published assets folder.
- * @return string the URL
- */
- public function getAssetsUrl()
- {
- if (isset($this->_assetsUrl))
- return $this->_assetsUrl;
- else
- {
- $assetsPath = Yii::getPathOfAlias('bootstrap.assets');
- $assetsUrl = Yii::app()->assetManager->publish($assetsPath, false, -1, YII_DEBUG);
- return $this->_assetsUrl = $assetsUrl;
- }
- }
- /**
- * Returns the extension version number.
- * @return string the version
- */
- public function getVersion()
- {
- return '1.0.5';
- }
- }