yii.gridView.js 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  1. /**
  2. * Yii GridView widget.
  3. *
  4. * This is the JavaScript widget used by the yii\grid\GridView widget.
  5. *
  6. * @link http://www.yiiframework.com/
  7. * @copyright Copyright (c) 2008 Yii Software LLC
  8. * @license http://www.yiiframework.com/license/
  9. * @author Qiang Xue <qiang.xue@gmail.com>
  10. * @since 2.0
  11. */
  12. (function ($) {
  13. $.fn.yiiGridView = function (method) {
  14. if (methods[method]) {
  15. return methods[method].apply(this, Array.prototype.slice.call(arguments, 1));
  16. } else if (typeof method === 'object' || !method) {
  17. return methods.init.apply(this, arguments);
  18. } else {
  19. $.error('Method ' + method + ' does not exist in jQuery.yiiGridView');
  20. return false;
  21. }
  22. };
  23. var defaults = {
  24. filterUrl: undefined,
  25. filterSelector: undefined
  26. };
  27. var gridData = {};
  28. var gridEvents = {
  29. /**
  30. * beforeFilter event is triggered before filtering the grid.
  31. * The signature of the event handler should be:
  32. * function (event)
  33. * where
  34. * - event: an Event object.
  35. *
  36. * If the handler returns a boolean false, it will stop filter form submission after this event. As
  37. * a result, afterFilter event will not be triggered.
  38. */
  39. beforeFilter: 'beforeFilter',
  40. /**
  41. * afterFilter event is triggered after filtering the grid and filtered results are fetched.
  42. * The signature of the event handler should be:
  43. * function (event)
  44. * where
  45. * - event: an Event object.
  46. */
  47. afterFilter: 'afterFilter'
  48. };
  49. /**
  50. * Used for storing active event handlers and removing them later.
  51. * The structure of single event handler is:
  52. *
  53. * {
  54. * gridViewId: {
  55. * type: {
  56. * event: '...',
  57. * selector: '...'
  58. * }
  59. * }
  60. * }
  61. *
  62. * Used types:
  63. *
  64. * - filter, used for filtering grid with elements found by filterSelector
  65. * - checkRow, used for checking single row
  66. * - checkAllRows, used for checking all rows with according "Check all" checkbox
  67. *
  68. * event is the name of event, for example: 'change.yiiGridView'
  69. * selector is a jQuery selector for finding elements
  70. *
  71. * @type {{}}
  72. */
  73. var gridEventHandlers = {};
  74. var methods = {
  75. init: function (options) {
  76. return this.each(function () {
  77. var $e = $(this);
  78. var settings = $.extend({}, defaults, options || {});
  79. var id = $e.attr('id');
  80. if (gridData[id] === undefined) {
  81. gridData[id] = {};
  82. }
  83. gridData[id] = $.extend(gridData[id], {settings: settings});
  84. var filterEvents = 'change.yiiGridView keydown.yiiGridView';
  85. var enterPressed = false;
  86. initEventHandler($e, 'filter', filterEvents, settings.filterSelector, function (event) {
  87. if (event.type === 'keydown') {
  88. if (event.keyCode !== 13) {
  89. return; // only react to enter key
  90. } else {
  91. enterPressed = true;
  92. }
  93. } else {
  94. // prevent processing for both keydown and change events
  95. if (enterPressed) {
  96. enterPressed = false;
  97. return;
  98. }
  99. }
  100. methods.applyFilter.apply($e);
  101. return false;
  102. });
  103. });
  104. },
  105. applyFilter: function () {
  106. var $grid = $(this);
  107. var settings = gridData[$grid.attr('id')].settings;
  108. var data = {};
  109. $.each($(settings.filterSelector).serializeArray(), function () {
  110. if (!(this.name in data)) {
  111. data[this.name] = [];
  112. }
  113. data[this.name].push(this.value);
  114. });
  115. var namesInFilter = Object.keys(data);
  116. $.each(yii.getQueryParams(settings.filterUrl), function (name, value) {
  117. if (namesInFilter.indexOf(name) === -1 && namesInFilter.indexOf(name.replace(/\[\]$/, '')) === -1) {
  118. if (!$.isArray(value)) {
  119. value = [value];
  120. }
  121. if (!(name in data)) {
  122. data[name] = value;
  123. } else {
  124. $.each(value, function (i, val) {
  125. if ($.inArray(val, data[name])) {
  126. data[name].push(val);
  127. }
  128. });
  129. }
  130. }
  131. });
  132. var pos = settings.filterUrl.indexOf('?');
  133. var url = pos < 0 ? settings.filterUrl : settings.filterUrl.substring(0, pos);
  134. var hashPos = settings.filterUrl.indexOf('#');
  135. if (pos >= 0 && hashPos >= 0) {
  136. url += settings.filterUrl.substring(hashPos);
  137. }
  138. $grid.find('form.gridview-filter-form').remove();
  139. var $form = $('<form/>', {
  140. action: url,
  141. method: 'get',
  142. 'class': 'gridview-filter-form',
  143. style: 'display:none',
  144. 'data-pjax': ''
  145. }).appendTo($grid);
  146. $.each(data, function (name, values) {
  147. $.each(values, function (index, value) {
  148. $form.append($('<input/>').attr({type: 'hidden', name: name, value: value}));
  149. });
  150. });
  151. var event = $.Event(gridEvents.beforeFilter);
  152. $grid.trigger(event);
  153. if (event.result === false) {
  154. return;
  155. }
  156. $form.submit();
  157. $grid.trigger(gridEvents.afterFilter);
  158. },
  159. setSelectionColumn: function (options) {
  160. var $grid = $(this);
  161. var id = $(this).attr('id');
  162. if (gridData[id] === undefined) {
  163. gridData[id] = {};
  164. }
  165. gridData[id].selectionColumn = options.name;
  166. if (!options.multiple || !options.checkAll) {
  167. return;
  168. }
  169. var checkAll = "#" + id + " input[name='" + options.checkAll + "']";
  170. var inputs = options['class'] ? "input." + options['class'] : "input[name='" + options.name + "']";
  171. var inputsEnabled = "#" + id + " " + inputs + ":enabled";
  172. initEventHandler($grid, 'checkAllRows', 'click.yiiGridView', checkAll, function () {
  173. $grid.find(inputs + ":enabled").prop('checked', this.checked);
  174. });
  175. initEventHandler($grid, 'checkRow', 'click.yiiGridView', inputsEnabled, function () {
  176. var all = $grid.find(inputs).length == $grid.find(inputs + ":checked").length;
  177. $grid.find("input[name='" + options.checkAll + "']").prop('checked', all);
  178. });
  179. },
  180. getSelectedRows: function () {
  181. var $grid = $(this);
  182. var data = gridData[$grid.attr('id')];
  183. var keys = [];
  184. if (data.selectionColumn) {
  185. $grid.find("input[name='" + data.selectionColumn + "']:checked").each(function () {
  186. keys.push($(this).parent().closest('tr').data('key'));
  187. });
  188. }
  189. return keys;
  190. },
  191. destroy: function () {
  192. var events = ['.yiiGridView', gridEvents.beforeFilter, gridEvents.afterFilter].join(' ');
  193. this.off(events);
  194. var id = $(this).attr('id');
  195. $.each(gridEventHandlers[id], function (type, data) {
  196. $(document).off(data.event, data.selector);
  197. });
  198. delete gridData[id];
  199. return this;
  200. },
  201. data: function () {
  202. var id = $(this).attr('id');
  203. return gridData[id];
  204. }
  205. };
  206. /**
  207. * Used for attaching event handler and prevent of duplicating them. With each call previously attached handler of
  208. * the same type is removed even selector was changed.
  209. * @param {jQuery} $gridView According jQuery grid view element
  210. * @param {string} type Type of the event which acts like a key
  211. * @param {string} event Event name, for example 'change.yiiGridView'
  212. * @param {string} selector jQuery selector
  213. * @param {function} callback The actual function to be executed with this event
  214. */
  215. function initEventHandler($gridView, type, event, selector, callback) {
  216. var id = $gridView.attr('id');
  217. var prevHandler = gridEventHandlers[id];
  218. if (prevHandler !== undefined && prevHandler[type] !== undefined) {
  219. var data = prevHandler[type];
  220. $(document).off(data.event, data.selector);
  221. }
  222. if (prevHandler === undefined) {
  223. gridEventHandlers[id] = {};
  224. }
  225. $(document).on(event, selector, callback);
  226. gridEventHandlers[id][type] = {event: event, selector: selector};
  227. }
  228. })(window.jQuery);