Tools for building extensions for the Yii PHP framework.

ExtensionBehavior.php

<?php
/**
 * C83ExtensionBehavior class file.
 * @author Christoffer Niska <[email protected]>
 * @copyright Copyright &copy; Christoffer Niska 2013-
 * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
 * @package vendor.crisu83.yii-extension.behaviors
 */

/**
 * Extension behavior for components.
 */
class C83ExtensionBehavior extends CBehavior
{
	private $_assetsUrl;
	private $_path;
	private $_alias;
	private $_clientScript;

	/**
	 * Creates a path alias for the extension.
	 * @param string $alias path alias to be imported.
	 * @param string $path path to the extension.
	 */
	public function createPathAlias($alias, $path)
	{
		$this->_alias = $alias;
		$this->_path = $path;
		Yii::setPathOfAlias($alias, $path);
	}

	/**
	 * Imports the a class or directory.
	 * The path alias is automatically prepended if applicable.
	 * @param string $alias path alias to be imported.
	 * @param boolean $forceInclude whether to include the class file immediately.
	 * @return string the class name or the directory that this alias refers to.
	 * @throws CException if the alias is invalid
	 */
	public function import($alias, $forceInclude = false)
	{
		if ($this->_alias !== null)
			$alias = $this->_alias . '.' . $alias;
		return Yii::import($alias, $forceInclude);
	}

	/**
	 * Publishes the extension assets.
	 * @param string $path assets path.
	 * @param boolean $forceCopy whether we should copy the asset file or directory even if it is already
	 * published before.
	 * @return string the url.
	 */
	public function publishAssets($path, $forceCopy = false)
	{
		if (!Yii::app()->hasComponent('assetManager'))
			return false;
		/* @var CAssetManager $assetManager */
		$assetManager = Yii::app()->getComponent('assetManager');
		if ($this->_path !== null)
			$path = $this->_path . DIRECTORY_SEPARATOR . $path;
		$assetsUrl = $assetManager->publish($path, false, -1, $forceCopy);
		return $this->_assetsUrl = $assetsUrl;
	}

	/**
	 * Registers a CSS file.
	 * @param string $url URL of the CSS file.
	 * @param string $media media that the CSS file should be applied to.
	 */
	public function registerCssFile($url, $media = '')
	{
		if (isset($this->_assetsUrl))
			$url = $this->_assetsUrl . '/' . ltrim($url, '/');
		$this->getClientScript()->registerCssFile($url, $media);
	}

	/**
	 * Registers a JavaScript file.
	 * @param string $url URL of the javascript file.
	 * @param integer $position the position of the JavaScript code.
	 */
	public function registerScriptFile($url, $position = null)
	{
		if (isset($this->_assetsUrl))
			$url = $this->_assetsUrl . '/' . ltrim($url, '/');
		$this->getClientScript()->registerScriptFile($url, $position);
	}

	/**
	 * Returns the path alias for the extension.
	 * @return string the alias or false if not set.
	 */
	public function getAlias()
	{
		return isset($this->_alias) ? $this->_alias : false;
	}

	/**
	 * Returns the client script component.
	 * @return CClientScript the component.
	 */
	protected function getClientScript()
	{
		if (isset($this->_clientScript))
			return $this->_clientScript;
		else
		{
			if (!Yii::app()->hasComponent('clientScript'))
				return false;
			return $this->_clientScript = Yii::app()->getComponent('clientScript');
		}
	}
}