JavaScript File

1/**

2 * Yii JavaScript module.

3 *

4 * @link https://www.yiiframework.com/

5 * @copyright Copyright (c) 2008 Yii Software LLC

6 * @license https://www.yiiframework.com/license/

7 * @author Qiang Xue <qiang.xue@gmail.com>

8 * @since 2.0

9 */

10

11/**

12 * yii is the root module for all Yii JavaScript modules.

13 * It implements a mechanism of organizing JavaScript code in modules through the function "yii.initModule()".

14 *

15 * Each module should be named as "x.y.z", where "x" stands for the root module (for the Yii core code, this is "yii").

16 *

17 * A module may be structured as follows:

18 *

19 * ```javascript

20 * window.yii.sample = (function($) {

21 * var pub = {

22 * // whether this module is currently active. If false, init() will not be called for this module

23 * // it will also not be called for all its child modules. If this property is undefined, it means true.

24 * isActive: true,

25 * init: function() {

26 * // ... module initialization code goes here ...

27 * },

28 *

29 * // ... other public functions and properties go here ...

30 * };

31 *

32 * // ... private functions and properties go here ...

33 *

34 * return pub;

35 * })(window.jQuery);

36 * ```

37 *

38 * Using this structure, you can define public and private functions/properties for a module.

39 * 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".

...