TbAlert

Complexity

Total Complexity

23

Size/Duplication

Total Lines	218
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

18.6%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	21	4
C	run()	0	47	8
F	renderSingleAlert()	0	45	10
A	isValidContext()	0	9	1

<?php
/**
 *## TbAlert class file.
 *
 * @author Christoffer Niska <ChristofferNiska@gmail.com>
 * @copyright Copyright &copy; Christoffer Niska 2011-
 * @license [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
 */
Yii::import('booster.widgets.TbWidget');
/**
 *## Bootstrap alert widget.
 *
 * Alert widget displays the messages set via CWebUser.setFlash() using the Twitter Bootstrap Alert widget.
 *
 * @see http://twitter.github.com/bootstrap/javascript.html#alerts
 *
 * @package booster.widgets.decoration
 */
class TbAlert extends TbWidget {
	
	const CTX_ERROR = 'error';
	const CTX_ERROR_CLASS = 'danger';
	
	/**
	 * @var array The configuration for individual types of alerts.
	 *
	 * Here's the allowed array elements:
	 *
	 * 'visible' (= null) If set to false, this type of alerts will not be rendered.
	 * 'fade' (= widget value) The same as a global fade property.
	 *   If set, alert will close itself fading away.
	 *   It defaults to the widget-level fade property value.
	 * 'htmlOptions' (= array()) Attributes for the individual alert panels.
	 *   Widget-level htmlOptions was for wrapper element around them.
	 *   Note that the class attribute will be appended with classes required for alert to be Twitter Bootstrap alert.
	 * 'closeText' (= widget value) The same as a global closeText property.
	 *   If set to false, close button will be removed from this type of alert.
	 *   It defaults to the widget-level closeText property value.
	 *
	 * @note Instead of full arrays you can use just the names of alert types as a values of the alerts property.
	 * You can even mix the array configuration and plain names.
	 *
	 * Default is the array of all alert types defined as TYPE_* constants.
	 * If you want no alerts to be displayed, set this property to empty array, not `null` value.
	 */
	public $alerts;

	/**
	 * @var string|boolean What to render as a button to close the alert panel.
	 *
	 * Default is to render a diagonal cross symbol.
	 * If set to false, no close button will be rendered, making user unable to close the alert.
	 */
	public $closeText = '&times;';

	/**
	 * @var boolean When set, alert will fade out using transitions when closed. Defaults to 'true'
	 */
	public $fade = true;

	/**
	 * @var string[] The Javascript event handlers attached to all alert elements being rendered.
	 *
	 * It should be an array with elements being a javascript string containing event handler function definition (along with declaration) and indexed with the names of events.
	 * This will be fed to jQuery.on verbatim.
	 *
	 * @volatile
	 */
	public $events = array();

	/**
	 * @var array Traditional property to set attributes to the element wrapping all of alerts.
	 */
	public $htmlOptions = array();

	/**
	 * @var string Name of the component which will be used to get alert messages.
	 *
	 * It should implement getFlash() method which returns alert message by its type.
	 * Default is 'user'.
	 */
	public $userComponentId = 'user';

	protected static $_containerId = 0;

	/**
	 *### .init()
	 *
	 * Initializes the widget.
	 */
	public function init() {
		
		if (!isset($this->htmlOptions['id'])) {
			$this->htmlOptions['id'] = $this->getId();
		}

		if (is_string($this->alerts)) {
			$this->alerts = array($this->alerts);
		}

		// Display all alert types by default.
		if (!isset($this->alerts)) {
			$this->alerts = array(
				self::CTX_SUCCESS,
				self::CTX_INFO,
				self::CTX_WARNING,
				self::CTX_DANGER,
				self::CTX_ERROR
			);
		}
	}

	/**
	 *### .run()
	 *
	 * Runs the widget.
	 */
	public function run() {
		
		$id = $this->htmlOptions['id'];

		echo CHtml::openTag('div', $this->htmlOptions);

		foreach ($this->alerts as $type => $alert) {

			if (is_string($alert)) {
				$type = $alert;
				$alert = array();
			}

			if (isset($alert['visible']) && $alert['visible'] === false) {
				continue;
			}

			/** @var CWebUser $userComponent */
			$userComponent = Yii::app()->getComponent($this->userComponentId);
			if (!$userComponent->hasFlash($type))
				continue;

			$alertText = $userComponent->getFlash($type);
            if (empty($alertText)) { // null, ''
                continue;
            }

			$this->renderSingleAlert($alert, $type, $alertText);
		}

		echo CHtml::closeTag('div');

		$id .= '_' . self::$_containerId++;
		$selector = "#{$id} .alert";

		/** @var CClientScript $cs */
		$cs = Yii::app()->getClientScript();
		$cs->registerScript(__CLASS__ . '#' . $id, "jQuery('{$selector}').alert();");

		foreach ($this->events as $name => $handler) {
			$handler = CJavaScript::encode($handler);
			$cs->registerScript(
				__CLASS__ . '#' . $id . '_' . $name,
				"jQuery('{$selector}').on('{$name}', {$handler});"
			);
		}
	}

	/**
	 * @param $alert
	 * @param $context
	 * @param $alertText
	 *
	 * @internal param $type
	 */
	protected function renderSingleAlert($alert, $context, $alertText) {
		
		$classes = array('alert in');

		if (!isset($alert['fade'])) {
			$alert['fade'] = $this->fade;
		}

		if ($alert['fade'] === true) {
			$classes[] = 'fade';
		}

		if ($this->isValidContext($context)) {
			$classes[] = 'alert-' . $this->getContextClass($context);
		}

		if (!isset($alert['htmlOptions'])) {
			$alert['htmlOptions'] = array();
		}

		$classes = implode(' ', $classes);
		if (isset($alert['htmlOptions']['class'])) {
			$alert['htmlOptions']['class'] .= ' ' . $classes;
		} else {
			$alert['htmlOptions']['class'] = $classes;
		}

		echo CHtml::openTag('div', $alert['htmlOptions']);

		// Logic is this: if no type-specific `closeText` was defined, let's show `$this->closeText`.
		// Else, show type-specific `closeText`. Treat 'false' differently.
		if (!isset($alert['closeText'])) {
			$alert['closeText'] = (isset($this->closeText) && $this->closeText !== false)
				? $this->closeText
				: false;
		}

		// If `closeText` which is in effect now is `false` then do not show button.
		if ($alert['closeText'] !== false) {
			echo '<a href="#" class="close" data-dismiss="alert">' . $alert['closeText'] . '</a>';
		}

		echo $alertText;
		echo CHtml::closeTag('div');
	}

	/**
	 * only these are allowed for alerts
	 *
	 * @param bool $context
	 *
	 * @return bool
	 */
	protected function isValidContext($context = false) {
		return in_array($context, array(
			self::CTX_SUCCESS,
			self::CTX_INFO,
			self::CTX_WARNING,
			self::CTX_DANGER,
			self::CTX_ERROR,
		));
	}
	
}