yii.js 7.73 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9
/**
 * Yii JavaScript module.
 *
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
Qiang Xue committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

/**
 * yii is the root module for all Yii JavaScript modules.
 * It implements a mechanism of organizing JavaScript code in modules through the function "yii.initModule()".
 *
 * Each module should be named as "x.y.z", where "x" stands for the root module (for the Yii core code, this is "yii").
 *
 * A module may be structured as follows:
 *
 * ~~~
 * yii.sample = (function($) {
 *     var pub = {
 *         // whether this module is currently active. If false, init() will not be called for this module
 *         // it will also not be called for all its child modules. If this property is undefined, it means true.
 *         isActive: true,
 *         init: function() {
 *             // ... module initialization code go here ...
 *         },
 *
 *         // ... other public functions and properties go here ...
 *     };
 *
 *     // ... private functions and properties go here ...
 *
 *     return pub;
Qiang Xue committed
35
 * })(jQuery);
Qiang Xue committed
36 37 38 39
 * ~~~
 *
 * Using this structure, you can define public and private functions/properties for a module.
 * Private functions/properties are only visible within the module, while public functions/properties
40
 * may be accessed outside of the module. For example, you can access "yii.sample.isActive".
Qiang Xue committed
41 42 43
 *
 * You must call "yii.initModule()" once for the root module of all your modules.
 */
Qiang Xue committed
44 45
yii = (function ($) {
	var pub = {
46 47 48 49 50
		/**
		 * List of scripts that can be loaded multiple times via AJAX requests. Each script can be represented
		 * as either an absolute URL or a relative one.
		 */
		reloadableScripts: [],
51
		/**
52
		 * The selector for clickable elements that need to support confirmation and form submission.
53
		 */
54 55 56 57 58
		clickableSelector: 'a, button, input[type="submit"], input[type="button"], input[type="reset"], input[type="image"]',
		/**
		 * The selector for changeable elements that need to support confirmation and form submission.
		 */
		changeableSelector: 'select, input, textarea',
59

60
		/**
61
		 * @return string|undefined the CSRF variable name. Undefined is returned if CSRF validation is not enabled.
62
		 */
63
		getCsrfVar: function () {
Qiang Xue committed
64
			return $('meta[name=csrf-var]').prop('content');
65 66 67
		},

		/**
68
		 * @return string|undefined the CSRF token. Undefined is returned if CSRF validation is not enabled.
69
		 */
70
		getCsrfToken: function () {
Qiang Xue committed
71
			return $('meta[name=csrf-token]').prop('content');
72
		},
73

74 75 76 77 78 79 80 81 82 83 84 85 86
		/**
		 * Displays a confirmation dialog.
		 * The default implementation simply displays a js confirmation dialog.
		 * You may override this by setting `yii.confirm`.
		 * @param message the confirmation message.
		 * @return boolean whether the user confirms with the message in the dialog
		 */
		confirm: function (message) {
			return confirm(message);
		},

		/**
		 * Returns a value indicating whether to allow executing the action defined for the specified element.
87 88 89
		 * This method recognizes the `data-confirm` attribute of the element and uses it
		 * as the message in a confirmation dialog. The method will return true if this special attribute
		 * is not defined or if the user confirms the message.
90 91 92 93 94
		 * @param $e the jQuery representation of the element
		 * @return boolean whether to allow executing the action defined for the specified element.
		 */
		allowAction: function ($e) {
			var message = $e.data('confirm');
95
			return message === undefined || pub.confirm(message);
96 97 98
		},

		/**
99 100 101 102 103 104 105 106 107 108
		 * Handles the action triggered by user.
		 * This method recognizes the `data-method` attribute of the element. If the attribute exists,
		 * the method will submit the form containing this element. If there is no containing form, a form
		 * will be created and submitted using the method given by this attribute value (e.g. "post", "put").
		 * For hyperlinks, the form action will take the value of the "href" attribute of the link.
		 * For other elements, either the containing form action or the current page URL will be used
		 * as the form action URL.
		 *
		 * If the `data-method` attribute is not defined, the default element action will be performed.
		 *
109
		 * @param $e the jQuery representation of the element
110
		 * @return boolean whether to execute the default action for the element.
111
		 */
112
		handleAction: function ($e) {
113 114
			var method = $e.data('method');
			if (method === undefined) {
115
				return true;
116 117 118
			}

			var $form = $e.closest('form');
119 120 121 122 123
			var newForm = !$form.length;
			if (newForm) {
				var action = $e.prop('href');
				if (!action || !action.match(/(^\/|:\/\/)/)) {
					action = window.location.href;
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
				}
				$form = $('<form method="' + method + '" action="' + action + '"></form>');
				var target = $e.prop('target');
				if (target) {
					$form.attr('target', target);
				}
				if (!method.match(/(get|post)/i)) {
					$form.append('<input name="_method" value="' + method + '" type="hidden">');
				}
				var csrfVar = pub.getCsrfVar();
				if (csrfVar) {
					$form.append('<input name="' + csrfVar + '" value="' + pub.getCsrfToken() + '" type="hidden">');
				}
				$form.hide().appendTo('body');
			}

			var activeFormData = $form.data('yiiActiveForm');
			if (activeFormData) {
				// remember who triggers the form submission. This is used by yii.activeForm.js
				activeFormData.submitObject = $e;
			}

			$form.trigger('submit');
147 148 149 150 151 152

			if (newForm) {
				$form.remove();
			}

			return false;
153 154
		},

Qiang Xue committed
155 156 157 158 159 160 161 162 163 164 165
		initModule: function (module) {
			if (module.isActive === undefined || module.isActive) {
				if ($.isFunction(module.init)) {
					module.init();
				}
				$.each(module, function () {
					if ($.isPlainObject(this)) {
						pub.initModule(this);
					}
				});
			}
166 167 168
		},

		init: function () {
169 170 171 172 173 174
			initCsrfHandler();
			initRedirectHandler();
			initScriptFilter();
			initDataMethods();
		}
	};
175

176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
	function initRedirectHandler() {
		// handle AJAX redirection
		$(document).ajaxComplete(function (event, xhr, settings) {
			var url = xhr.getResponseHeader('X-Redirect');
			if (url) {
				window.location = url;
			}
		});
	}

	function initCsrfHandler() {
		// automatically send CSRF token for all AJAX requests
		$.ajaxPrefilter(function (options, originalOptions, xhr) {
			if (!options.crossDomain && pub.getCsrfVar()) {
				xhr.setRequestHeader('X-CSRF-Token', pub.getCsrfToken());
			}
		});
	}

	function initDataMethods() {
		var $document = $(document);
		// handle data-confirm and data-method for clickable elements
		$document.on('click.yii', pub.clickableSelector, function (event) {
			var $this = $(this);
			if (pub.allowAction($this)) {
				return pub.handleAction($this);
			} else {
				event.stopImmediatePropagation();
				return false;
			}
		});

		// handle data-confirm and data-method for changeable elements
		$document.on('change.yii', pub.changeableSelector, function (event) {
			var $this = $(this);
			if (pub.allowAction($this)) {
				return pub.handleAction($this);
			} else {
				event.stopImmediatePropagation();
				return false;
			}
		});
	}

	function initScriptFilter() {
		var hostInfo = location.protocol + '//' + location.host;
Alex-Code committed
222
		var loadedScripts = $('script[src]').map(function () {
223 224 225 226
			return this.src.charAt(0) === '/' ? hostInfo + this.src : this.src;
		}).toArray();
		$.ajaxPrefilter('script', function (options, originalOptions, xhr) {
			var url = options.url.charAt(0) === '/' ? hostInfo + options.url : options.url;
Alex-Code committed
227
			if ($.inArray(url, loadedScripts) === -1) {
228 229
				loadedScripts.push(url);
			} else {
Alex-Code committed
230 231 232
				var found = $.inArray(url, $.map(pub.reloadableScripts, function (script) {
					return script.charAt(0) === '/' ? hostInfo + script : script;
				})) !== -1;
233 234
				if (!found) {
					xhr.abort();
235
				}
236 237 238
			}
		});
	}
239

Qiang Xue committed
240
	return pub;
Qiang Xue committed
241
})(jQuery);
Qiang Xue committed
242

Qiang Xue committed
243 244
jQuery(document).ready(function () {
	yii.initModule(yii);
Qiang Xue committed
245
});