yii2-bootstrap/yii/bootstrap/widgets/Modal.php

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\bootstrap\widgets;

use Yii;
use yii\helpers\Html;
use yii\helpers\ArrayHelper;
use yii\bootstrap\helpers\Button;
use yii\bootstrap\enum\BootstrapEnum;
use yii\web\JsExpression;

/**
 * Modal renders a bootstrap modal on the page for its use on your application.
 *
 * Basic usage:
 *
 * ```php
 * $this->widget(Modal::className(), array(
 * 	'id' => 'myModal',
 * 	'header' => 'Modal Heading',
 * 	'content' => '<p>One fine body...</p>',
 * 	'footer' => '//modal/_footer', // we can also use view paths
 * 	'buttonOptions' => array(
 * 		'label' => 'Show Modal',
 * 		'class' => \yii\bootstrap\enum\ButtonEnum::TYPE_DEFAULT
 * 		)
 * ));
 * ```
 * @see http://twitter.github.io/bootstrap/javascript.html#modals
 * @author Antonio Ramirez <amigo.cobos@gmail.com>
 * @since 2.0
 */
class Modal extends base\BootstrapWidget
{
	/**
	 * @var array  The additional HTML attributes of the button that will show the modal. If empty array, only
	 * the markup of the modal will be rendered on the page, so users can easily call the modal manually with their own
	 * scripts. The following special attributes are available:
	 * <ul>
	 *    <li>label: string, the label of the button</li>
	 * </ul>
	 *
	 * For available options of the button trigger, see http://twitter.github.com/bootstrap/javascript.html#modals.
	 */
	public $buttonOptions = array();

	/**
	 * @var boolean indicates whether the modal should use transitions. Defaults to 'true'.
	 */
	public $fade = true;

	/**
	 * @var bool $keyboard, closes the modal when escape key is pressed.
	 */
	public $keyboard = true;

	/**
	 * @var bool $show, shows the modal when initialized.
	 */
	public $show = false;

	/**
	 * @var mixed includes a modal-backdrop element. Alternatively, specify `static` for a backdrop which doesn't close
	 * the modal on click.
	 */
	public $backdrop = true;

	/**
	 * @var mixed the remote url. If a remote url is provided, content will be loaded via jQuery's load method and
	 * injected into the .modal-body of the modal.
	 */
	public $remote;

	/**
	 * @var string a javascript function that will be invoked immediately when the `show` instance method is called.
	 */
	public $onShow;

	/**
	 * @var string a javascript function that will be invoked when the modal has been made visible to the user
	 *     (will wait for css transitions to complete).
	 */
	public $onShown;

	/**
	 * @var string a javascript function that will be invoked immediately when the hide instance method has been called.
	 */
	public $onHide;

	/**
	 * @var string a javascript function that will be invoked when the modal has finished being hidden from the user
	 *     (will wait for css transitions to complete).
	 */
	public $onHidden;

	/**
	 * @var string[] the Javascript event handlers.
	 */
	protected $events = array();

	/**
	 * @var array $pluginOptions the plugin options.
	 */
	protected $pluginOptions = array();

	/**
	 * @var string
	 */
	public $closeText = '&times;';

	/**
	 * @var string header content. Header can also be a path to a view file.
	 */
	public $header;

	/**
	 * @var string body of modal. Body can also be a path to a view file.
	 */
	public $content;

	/**
	 * @var string footer content. Content can also be a path to a view file.
	 */
	public $footer;

	/**
	 * Widget's init method
	 */
	public function init()
	{
		parent::init();

		$this->name = 'modal';

		$this->defaultOption('id', $this->getId());
		$this->selector = '#' . ArrayHelper::getValue($this->options, 'id');

		$this->defaultOption('role', BootstrapEnum::DIALOG);
		$this->defaultOption('tabindex', '-1');

		$this->addOption('class', BootstrapEnum::MODAL);
		$this->addOption('class', BootstrapEnum::HIDE);

		if ($this->fade)
			$this->addOption('class', BootstrapEnum::FADE);

		$this->initPluginOptions();
		$this->initPluginEvents();
	}

	/**
	 * Initialize plugin events if any
	 */
	public function initPluginEvents()
	{
		foreach (array('onShow', 'onShown', 'onHide', 'onHidden') as $event) {
			if ($this->{$event} !== null) {
				$modalEvent = strtolower(substr($event, 2));
				if ($this->{$event} instanceof JsExpression)
					$this->events[$modalEvent] = $this->$event;
				else
					$this->events[$modalEvent] = new JsExpression($this->{$event});
			}
		}
	}

	/**
	 * Initialize plugin options.
	 * ***Important***: The display of the button overrides the initialization of the modal bootstrap widget.
	 */
	public function initPluginOptions()
	{
		if (null !== $this->remote)
			$this->pluginOptions['remote'] = Html::url($this->remote);

		foreach (array('backdrop', 'keyboard', 'show') as $option) {
			$this->pluginOptions[$option] = isset($this->pluginOptions[$option])
				? $this->pluginOptions[$option]
				: $this->{$option};
		}
	}

	/**
	 * Widget's run method
	 */
	public function run()
	{
		$this->renderModal();
		$this->renderButton();
		$this->registerScript();
	}

	/**
	 * Renders the button that will open the modal if its options have been configured
	 */
	public function renderButton()
	{
		if (!empty($this->buttonOptions)) {

			$this->buttonOptions['data-toggle'] = isset($this->buttonOptions['data-toggle'])
				? $this->buttonOptions['data-toggle']
				: BootstrapEnum::MODAL;

			if ($this->remote !== null && !isset($this->buttonOptions['data-remote']))
				$this->buttonOptions['data-remote'] = Html::url($this->remote);

			$label = ArrayHelper::remove($this->buttonOptions, 'label', 'Button');
			$name = ArrayHelper::remove($this->buttonOptions, 'name');
			$value = ArrayHelper::remove($this->buttonOptions, 'value');

			$attr = isset($this->buttonOptions['data-remote'])
				? 'data-target'
				: 'href';

			$this->buttonOptions[$attr] = isset($this->buttonOptions[$attr])
				? $this->buttonOptions[$attr]
				: $this->selector;

			echo Html::button($label, $name, $value, $this->buttonOptions);
		}
	}

	/**
	 * Renders the modal markup
	 */
	public function renderModal()
	{
		echo Html::beginTag('div', $this->options) . PHP_EOL;

		$this->renderModalHeader();
		$this->renderModalBody();
		$this->renderModalFooter();

		echo Html::endTag('div') . PHP_EOL;
	}

	/**
	 * Renders the header HTML markup of the modal
	 */
	public function renderModalHeader()
	{
		echo '<div class="modal-header">' . PHP_EOL;
		if ($this->closeText)
			echo Button::closeButton($this->closeText, BootstrapEnum::MODAL);
		echo $this->renderSection($this->header);
		echo '</div>' . PHP_EOL;
	}

	/**
	 * Renders the HTML markup for the body of the modal
	 */
	public function renderModalBody()
	{
		echo '<div class="modal-body">' . PHP_EOL;
		echo $this->renderSection($this->content);
		echo '</div>' . PHP_EOL;
	}

	/**
	 * Renders the HTML markup for the footer of the modal
	 */
	public function renderModalFooter()
	{

		echo '<div class="modal-footer">' . PHP_EOL;
		echo $this->renderSection($this->footer);
		echo '</div>' . PHP_EOL;
	}

	/**
	 * Renders a section. If the section is a view file, the returned string will be the contents of the view file,
	 * otherwise, it will return the string in the $section variable.
	 * @param string $section
	 * @return string
	 */
	public function renderSection($section)
	{
		$viewFile = Yii::getAlias($section);
		if (is_file($viewFile))
			return $this->view->renderFile($viewFile, array(), $this);
		return $section;
	}

	/**
	 * Registers client scripts
	 */
	public function registerScript()
	{
		// do we render a button? If so, bootstrap will handle its behavior through its
		// mark-up, otherwise, register the plugin.
		if(empty($this->buttonOptions))
			$this->registerPlugin($this->selector, $this->pluginOptions);

		// register events
		$this->registerEvents($this->selector, $this->events);
	}

}