BxBaseGrid.php 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897
  1. <?php defined('BX_DOL') or die('hack attempt');
  2. /**
  3. * Copyright (c) UNA, Inc - https://una.io
  4. * MIT License - https://opensource.org/licenses/MIT
  5. *
  6. * @defgroup UnaBaseView UNA Base Representation Classes
  7. * @{
  8. */
  9. /**
  10. * Grid representation.
  11. * @see BxDolGrid
  12. */
  13. class BxBaseGrid extends BxDolGrid
  14. {
  15. protected $_oTemplate;
  16. protected $_aPopupOptions = false;
  17. protected $_aQueryAppend = [];
  18. protected $_aQueryAppendExclude = false; // an array of keys which shouldn't be pathed in http requests, but can be stored (used) in 'Query Append' array.
  19. protected $_aQueryAppendExcludeApi = false;
  20. protected $_aQueryReset = false;
  21. protected $_aConfirmMessages = false;
  22. protected $_bSelectAll = false;
  23. protected $_isDisplayPopupOnTextOverflow = true;
  24. public function __construct ($aOptions, $oTemplate)
  25. {
  26. parent::__construct ($aOptions);
  27. if ($oTemplate)
  28. $this->_oTemplate = $oTemplate;
  29. else
  30. $this->_oTemplate = BxDolTemplate::getInstance();
  31. $this->_aPopupOptions = [];
  32. $this->_aQueryAppend = [
  33. $this->_oTemplate->getCodeKey() => $this->_oTemplate->getCode()
  34. ];
  35. $this->_aQueryAppendExclude = [];
  36. $this->_aQueryAppendExcludeApi = [$this->_oTemplate->getCodeKey()];
  37. $this->_aQueryReset = [
  38. $this->_aOptions['filter_get'],
  39. $this->_aOptions['order_get_field'],
  40. $this->_aOptions['order_get_dir'],
  41. $this->_aOptions['paginate_get_start'],
  42. $this->_aOptions['paginate_get_per_page']
  43. ];
  44. $this->_aConfirmMessages = [];
  45. }
  46. public function performActionDisplay()
  47. {
  48. if($this->_bIsApi)
  49. return $this->getCodeAPI();
  50. require_once(BX_DIRECTORY_PATH_INC . "design.inc.php");
  51. echoJson(array(
  52. 'grid' => $this->getCode(false),
  53. 'total_count' => $this->_iTotalCount,
  54. 'total_count_f' => $this->_getCounter()
  55. ));
  56. }
  57. public function performActionReorder()
  58. {
  59. $this->_replaceMarkers ();
  60. $aOrder = bx_get($this->_sObject . '_row');
  61. $iOrder = 0;
  62. foreach ($aOrder as $mixedId)
  63. $this->_updateOrder($mixedId, ++$iOrder);
  64. echoJson(array());
  65. }
  66. public function performActionDelete()
  67. {
  68. $aResult = [];
  69. $this->_replaceMarkers ();
  70. $iAffected = 0;
  71. $aIds = bx_get('ids');
  72. if (!$aIds || !is_array($aIds))
  73. return echoJson($aResult);
  74. foreach ($aIds as $mixedId)
  75. $iAffected += $this->_delete($mixedId) ? 1 : 0;
  76. if($iAffected)
  77. $aResult = !$this->_bIsApi ? ['grid' => $this->getCode(false)] : [];
  78. else
  79. $aResult = ['msg' => _t("_sys_grid_delete_failed")];
  80. return $this->_bIsApi ? $aResult : echoJson($aResult);
  81. }
  82. public function performActionEnable($mixedChecked = null)
  83. {
  84. $this->_replaceMarkers ();
  85. $aIds = bx_get('ids');
  86. if (!$aIds || !is_array($aIds)) {
  87. echoJson(array());
  88. exit;
  89. }
  90. $iChecked = (int)($mixedChecked !== null ? $mixedChecked : bx_get('checked'));
  91. $aAffectedIds = array ();
  92. foreach ($aIds as $mixedId)
  93. if ($this->_enable($mixedId, $iChecked))
  94. $aAffectedIds[] = preg_match("/^[\d\w]+$/", $mixedId) ? $mixedId : (int)$mixedId;
  95. $sAction = $iChecked ? 'enable' : 'disable';
  96. if($this->_bIsApi)
  97. return $aAffectedIds;
  98. echo echoJson(array($sAction => $aAffectedIds));
  99. }
  100. public function getCode ($isDisplayHeader = true)
  101. {
  102. $this->_replaceMarkers ();
  103. if ($isDisplayHeader && empty($this->_aOptions['paginate_url'])) {
  104. // reset page query params if grid is just initialized and it uses AJAX paginate
  105. $this->resetQueryParams();
  106. }
  107. $sPaginate = '';
  108. $aData = array();
  109. $sIdWrapper = 'bx-grid-wrap-' . $this->_sObject;
  110. $sIdContainer = 'bx-grid-cont-' . $this->_sObject;
  111. $sIdTable = 'bx-grid-table-' . $this->_sObject;
  112. $sFilter = bx_unicode_urldecode(bx_process_input(bx_get($this->_aOptions['filter_get'])));
  113. $sOrderField = bx_unicode_urldecode(bx_process_input(bx_get($this->_aOptions['order_get_field'])));
  114. $sOrderDir = 0 === strcasecmp('desc', bx_get($this->_aOptions['order_get_dir'])) ? 'DESC' : 'ASC';
  115. $iStart = 0;
  116. if($this->_aOptions['paginate_get_start'] && ($iStartGet = (int)bx_get($this->_aOptions['paginate_get_start'])) >= 0)
  117. $iStart = $iStartGet;
  118. $iPerPage = 10;
  119. if($this->_aOptions['paginate_get_per_page'] && ($iPerPageGet = (int)bx_get($this->_aOptions['paginate_get_per_page'])) > 0)
  120. $iPerPage = $iPerPageGet;
  121. else if($this->_aOptions['paginate_per_page'])
  122. $iPerPage = (int)$this->_aOptions['paginate_per_page'];
  123. if ($this->_aOptions['paginate_get_start']) {
  124. $aData = $this->_getData ($sFilter, $sOrderField, $sOrderDir, $iStart, $iPerPage + 1);
  125. $sPageUrl = false;
  126. if (!empty($this->_aOptions['paginate_url'])) {
  127. $sPageUrl = $this->_aOptions['paginate_url'];
  128. $aParamsAppend = array();
  129. if ($sFilter) {
  130. $aParamsAppend['filter'] = bx_process_input(bx_get($this->_aOptions['filter_get']));
  131. }
  132. if ($sOrderField) {
  133. $aParamsAppend['order_field'] = bx_process_input(bx_get($this->_aOptions['order_get_field']));
  134. $aParamsAppend['order_dir'] = bx_process_input(bx_get($this->_aOptions['order_get_dir']));
  135. }
  136. if ($aParamsAppend)
  137. $sPageUrl = bx_append_url_params($sPageUrl, $aParamsAppend);
  138. }
  139. $aPaginateParams = array(
  140. 'start' => $iStart,
  141. 'per_page' => $iPerPage,
  142. 'page_url' => $sPageUrl ? $sPageUrl : "javascript:glGrids." . $this->_sObject . ".reload('{start}'); void(0);",
  143. );
  144. $oPaginate = new BxTemplPaginate($aPaginateParams, $this->_oTemplate);
  145. $oPaginate->setNumFromDataArray($aData);
  146. if (isset($this->_aOptions['paginate_simple']) && false !== $this->_aOptions['paginate_simple'])
  147. $sPaginate = $oPaginate->getSimplePaginate($this->_aOptions['paginate_simple']);
  148. else
  149. $sPaginate = $oPaginate->getPaginate();
  150. } else {
  151. $aData = $this->_getData ($sFilter, $sOrderField, $sOrderDir, $iStart, $iPerPage);
  152. }
  153. if((empty($aData) || !is_array($aData)) && isset($this->_aBrowseParams['empty_message']) && !(bool)$this->_aBrowseParams['empty_message'])
  154. return '';
  155. $sPopupOptions = '{}';
  156. if (!empty($this->_aPopupOptions) && is_array($this->_aPopupOptions))
  157. $sPopupOptions = json_encode($this->_aPopupOptions);
  158. $aQueryAppend = array_merge(is_array($this->_aQueryAppend) ? $this->_aQueryAppend : array(), is_array($this->_aMarkers) ? $this->_aMarkers : array());
  159. if(!empty($this->_aQueryAppendExclude) && is_array($this->_aQueryAppendExclude))
  160. $aQueryAppend = array_diff_key($aQueryAppend, array_flip($this->_aQueryAppendExclude));
  161. $sQueryAppend = '{}';
  162. if (!empty($aQueryAppend) && is_array($aQueryAppend))
  163. $sQueryAppend = json_encode($aQueryAppend);
  164. $sConfirmMessages = '{}';
  165. if (!empty($this->_aConfirmMessages) && is_array($this->_aConfirmMessages))
  166. $sConfirmMessages = json_encode($this->_aConfirmMessages);
  167. $iColumns = count($this->_aOptions['fields']);
  168. $aVarsHead = $this->_getRowHead();
  169. $sClassHeader = '';
  170. if($this->_aOptions['show_total_count'] == 0)
  171. $sClassHeader .= ' bx-gh-no-counter';
  172. $aVars = array (
  173. 'object' => $this->_sObject,
  174. 'csrf_token' => BxDolForm::getCsrfToken(),
  175. 'id_table' => $sIdTable,
  176. 'id_cont' => $sIdContainer,
  177. 'id_wrap' => $sIdWrapper,
  178. 'class_table_wrapper' => $this->_aOptions['responsive'] ? 'bx-grid-table-wrapper-responsive' : '',
  179. 'sortable' => empty($this->_aOptions['field_order']) ? 0 : 1,
  180. 'sorting' => empty($this->_aOptions['sorting_fields']) ? 0 : 1,
  181. 'sorting_field' => $sOrderField,
  182. 'sorting_dir' => $sOrderDir,
  183. 'bx_if:display_head' => array(
  184. 'condition' => !empty($aVarsHead),
  185. 'content' => array(
  186. 'bx_repeat:row_header' => $aVarsHead,
  187. 'columns' => $iColumns,
  188. )
  189. ),
  190. 'bx_repeat:rows_data' => $this->_getRowsDataDesign ($aData),
  191. 'paginate_get_start' => $this->_aOptions['paginate_get_start'],
  192. 'paginate_get_per_page' => $this->_aOptions['paginate_get_per_page'],
  193. 'start' => $iStart,
  194. 'per_page' => $iPerPage,
  195. 'filter' => bx_js_string($sFilter, BX_ESCAPE_STR_APOS),
  196. 'filter_get' => bx_js_string($this->_aOptions['filter_get']),
  197. 'order_field' => bx_js_string($sOrderField, BX_ESCAPE_STR_APOS),
  198. 'order_dir' => bx_js_string($sOrderDir, BX_ESCAPE_STR_APOS),
  199. 'order_get_field' => bx_js_string($this->_aOptions['order_get_field']),
  200. 'order_get_dir' => bx_js_string($this->_aOptions['order_get_dir']),
  201. 'popup_options' => $sPopupOptions,
  202. 'query_append' => $sQueryAppend,
  203. 'confirm_messages' => $sConfirmMessages,
  204. 'columns' => $iColumns,
  205. 'bx_if:display_footer' => array(
  206. 'condition' => !empty($this->_aOptions['actions_bulk']) || !empty($sPaginate),
  207. 'content' => array(
  208. 'bx_if:actions_bulk' => array (
  209. 'condition' => !empty($this->_aOptions['actions_bulk']),
  210. 'content' => array(
  211. 'actions_bulk' => $this->_getActions ('bulk'),
  212. ),
  213. ),
  214. 'paginate' => $sPaginate,
  215. )
  216. ),
  217. 'bx_if:display_header' => array (
  218. 'condition' => $isDisplayHeader,
  219. 'content' => array (
  220. 'class' => $sClassHeader,
  221. 'bx_if:actions_independent' => array (
  222. 'condition' => !empty($this->_aOptions['actions_independent']),
  223. 'content' => array(
  224. 'actions_independent' => $this->_getActions ('independent'),
  225. ),
  226. ),
  227. 'bx_if:filter' => array (
  228. 'condition' => !empty($this->_aOptions['filter_fields']) || !empty($this->_aOptions['filter_fields_translatable']),
  229. 'content' => array(
  230. 'controls' => $this->_getFilterControls(),
  231. ),
  232. ),
  233. 'bx_if:counter' => array (
  234. 'condition' => $this->_aOptions['show_total_count'] == 1,
  235. 'content' => array(
  236. 'counter' => $this->_getCounter(),
  237. ),
  238. ),
  239. ),
  240. ),
  241. );
  242. $this->_addJsCss();
  243. return $this->_oTemplate->parseHtmlByName('grid.html', $aVars);
  244. }
  245. /**
  246. * Get grid code API.
  247. * @return array
  248. */
  249. public function getCodeAPI()
  250. {
  251. $this->_replaceMarkers ();
  252. $sFilter = bx_unicode_urldecode(bx_process_input(bx_get($this->_aOptions['filter_get'])));
  253. $sOrderField = bx_unicode_urldecode(bx_process_input(bx_get($this->_aOptions['order_get_field'])));
  254. $sOrderDir = 0 === strcasecmp('desc', bx_get($this->_aOptions['order_get_dir'])) ? 'DESC' : 'ASC';
  255. $iStart = 0;
  256. if($this->_aOptions['paginate_get_start'] && ($iStartGet = (int)bx_get($this->_aOptions['paginate_get_start'])) >= 0)
  257. $iStart = $iStartGet;
  258. $iPerPage = 10;
  259. if($this->_aOptions['paginate_get_per_page'] && ($iPerPageGet = (int)bx_get($this->_aOptions['paginate_get_per_page'])) > 0)
  260. $iPerPage = $iPerPageGet;
  261. else if($this->_aOptions['paginate_per_page'])
  262. $iPerPage = (int)$this->_aOptions['paginate_per_page'];
  263. $aData = $this->_getData($sFilter, $sOrderField, $sOrderDir, $iStart, $iPerPage);
  264. if(!empty($aData) && is_array($aData))
  265. $aData = $this->decodeDataAPI($aData);
  266. $aQueryAppend = [];
  267. if(!empty($this->_aQueryAppend) && is_array($this->_aQueryAppend))
  268. $aQueryAppend = array_merge($aQueryAppend, $this->_aQueryAppend);
  269. if(!empty($this->_aQueryAppendExclude) && is_array($this->_aQueryAppendExclude))
  270. $aQueryAppend = array_diff_key($aQueryAppend, array_flip($this->_aQueryAppendExclude));
  271. if(!empty($this->_aQueryAppendExcludeApi) && is_array($this->_aQueryAppendExcludeApi))
  272. $aQueryAppend = array_diff_key($aQueryAppend, array_flip($this->_aQueryAppendExcludeApi));
  273. return [
  274. 'settings' => [
  275. 'object' => $this->_aOptions['object'],
  276. 'field_id' => $this->_aOptions['field_id'],
  277. 'start' => $iStart,
  278. 'per_page' => $iPerPage,
  279. 'filters' => $this->_getFilterControlsAPI(),
  280. 'query_append' => $aQueryAppend
  281. ],
  282. 'header' => $this->_getRowHeadAPI(),
  283. 'data' => defined('BX_API_PAGE') ? [] : $aData,
  284. 'actions' => [
  285. 'independent' => $this->_getActionsAPI('independent'),
  286. 'bulk' => $this->_getActionsAPI('bulk')
  287. ]
  288. ];
  289. }
  290. public function decodeDataAPI($aData)
  291. {
  292. $aDataRv = [];
  293. foreach($aData as $iKey => $aRow) {
  294. $aDataRv[$iKey] = [];
  295. foreach($this->_aOptions['fields'] as $sKey => $aField){
  296. $aDataRv[$iKey]['id'] = $aData[$iKey]['id'];
  297. $sMethod = '_getCellDefault';
  298. $sCustomMethod = '_getCell' . $this->_genMethodName($sKey);
  299. if (method_exists($this, $sCustomMethod)){
  300. $sMethod = $sCustomMethod;
  301. $s = $this->$sMethod($aData[$iKey][$sKey], $sKey, $aField, $aRow);
  302. $aDataRv[$iKey][$sKey] = $s;
  303. }
  304. else{
  305. $aDataRv[$iKey][$sKey] = ['type' => 'text', 'value'=> $aData[$iKey][$sKey]];
  306. }
  307. }
  308. }
  309. return $aDataRv;
  310. }
  311. function getFormBlockAPI($oForm, $sAction, $iId = 0){
  312. return [
  313. bx_api_get_block(
  314. 'form',
  315. $oForm->getCodeAPI(),
  316. ['ext' => [
  317. 'name' => $this->_oModule->getName(),
  318. 'request' => ['url' => $this->getFormCallBackUrlAPI($sAction, $iId), 'immutable' => true]]
  319. ]
  320. )
  321. ];
  322. }
  323. /**
  324. * Reset query params, like filter and page number
  325. */
  326. public function resetQueryParams()
  327. {
  328. foreach ($this->_aQueryReset as $sKey) {
  329. unset($_GET[$sKey]);
  330. unset($_POST[$sKey]);
  331. }
  332. }
  333. protected function _getRowHead()
  334. {
  335. $aRet = array();
  336. foreach ($this->_aOptions['fields'] as $sKey => $a) {
  337. $sMethod = '_getCellHeaderDefault';
  338. $sCustomMethod = '_getCellHeader' . $this->_genMethodName($sKey);
  339. if (method_exists($this, $sCustomMethod))
  340. $sMethod = $sCustomMethod;
  341. $aRet[] = array('header_cell' => $this->$sMethod($sKey, $a));
  342. }
  343. return $aRet;
  344. }
  345. protected function _getRowHeadAPI()
  346. {
  347. $aHeader = [];
  348. foreach($this->_aOptions['fields'] as $sKey => $aField)
  349. $aHeader[] = [
  350. 'name' => bx_process_output($aField['name']),
  351. 'title' => bx_process_output($aField['title']),
  352. 'width' => $aField['width']
  353. ];
  354. return $aHeader;
  355. }
  356. protected function _getCellHeaderDefault ($sKey, $aField)
  357. {
  358. $sHeader = bx_process_output($aField['title']);
  359. if (!empty($this->_aOptions['sorting_fields']) && is_array($this->_aOptions['sorting_fields']) && in_array($sKey, $this->_aOptions['sorting_fields'])) {
  360. $sHeader = '<a href="javascript:void(0);" class="bx-grid-sort-handle">' . $sHeader . '</a><span class="bx-grid-sort-indi"></span>';
  361. $aField['attr_head']['bx_grid_sort_head'] = $sKey;
  362. }
  363. $sAttr = $this->_convertAttrs(
  364. $aField, 'attr_head',
  365. 'bx-def-padding-sec-bottom bx-def-padding-sec-top bx-grid-header-' . $sKey, // add default classes
  366. isset($aField['width']) ? 'width:' . $aField['width'] : false // add default styles
  367. );
  368. return $this->_getCellHeaderWrapper ($sKey, $aField, $sHeader, $sAttr);
  369. }
  370. protected function _getCellHeaderCheckbox ($sKey, $aField)
  371. {
  372. $aAttr = array(
  373. 'type' => 'checkbox',
  374. 'id' => $this->_sObject . '_check_all',
  375. 'name' => $this->_sObject . '_check_all',
  376. 'onclick' => "$('input[name=" . $this->_sObject . "_check]:not([disabled])').attr('checked', this.checked)"
  377. );
  378. if($this->_bSelectAll)
  379. $aAttr['checked'] = 'checked';
  380. $aField['attr'] = isset($aField['attr']) && is_array($aField['attr']) ? array_merge($aAttr, $aField['attr']) : $aAttr;
  381. $sAttrHead = $this->_convertAttrs(
  382. $aField, 'attr_head',
  383. 'bx-def-padding-sec-bottom bx-def-padding-sec-top bx-grid-header-' . $sKey, // add default classes
  384. isset($aField['width']) ? 'width:' . $aField['width'] : false // add default styles
  385. );
  386. return $this->_getCellHeaderWrapper ($sKey, $aField, ' <input ' . $this->_convertAttrs($aField, 'attr') . ' /> ', $sAttrHead);
  387. }
  388. protected function _getCellHeaderWrapper ($sKey, $aField, $sHeader, $sAttr)
  389. {
  390. return '<th ' . $sAttr . '>' . $sHeader . '</th>';
  391. }
  392. /**
  393. * Check if the whole row is disabled.
  394. * When row is disabled - checkbox is not selectable, actions aren't clickable and text is grayed out.
  395. * By default all rows aren't disabled.
  396. * @param $aRow row array
  397. * @return boolean
  398. */
  399. protected function _isRowDisabled($aRow)
  400. {
  401. if (isset($aRow[$this->_aOptions['field_active']]) && !$this->_switcherState2Checked($aRow[$this->_aOptions['field_active']]))
  402. return true;
  403. return false;
  404. }
  405. /**
  406. * Determine how actions are disabled when whole row is disabled.
  407. * @param $aRow row array
  408. * @return null - disable/enable actions when row is disabled/enabled, true - actions are always disabled, false - actions are always enabled
  409. */
  410. protected function _getActionsDisabledBehavior($aRow)
  411. {
  412. return null;
  413. }
  414. /**
  415. * Check if the checkbox is disabled.
  416. * @param $aRow row array
  417. * @return boolean
  418. */
  419. protected function _isCheckboxDisabled($aRow)
  420. {
  421. return $this->_isRowDisabled($aRow);
  422. }
  423. /**
  424. * Is checkbox checked by default ?
  425. * By default no one checkbox is selected.
  426. * @return boolean
  427. */
  428. protected function _isCheckboxSelected($mixedValue, $sKey, $aField, $aRow)
  429. {
  430. return $this->_bSelectAll;
  431. }
  432. /**
  433. * Is switcher on by default ?
  434. * By default no one switcher is on.
  435. * @return boolean
  436. */
  437. protected function _isSwitcherOn($mixedValue, $sKey, $aField, $aRow)
  438. {
  439. return $this->_switcherState2Checked($mixedValue);
  440. }
  441. /**
  442. * Convert switcher checked status to the actual value ?
  443. * @return boolean
  444. */
  445. protected function _switcherChecked2State($isChecked)
  446. {
  447. return $isChecked ? 1 : 0;
  448. }
  449. /**
  450. * Convert switcher value to checked(boolean) value ?
  451. * @return boolean
  452. */
  453. protected function _switcherState2Checked($mixedState)
  454. {
  455. return $mixedState ? true : false;
  456. }
  457. protected function _getRowsDataDesign (&$aData)
  458. {
  459. $aGrid = array();
  460. if(empty($aData))
  461. $aGrid[] = array(
  462. 'id_row' => 0,
  463. 'row_class' => 'bx-grid-table-row-empty',
  464. 'row' => '<td class="bx-def-padding-sec-topbottom" colspan="' . count($this->_aOptions['fields']) . '">' . MsgBox(_t('_Empty')) . '</td>'
  465. );
  466. else
  467. foreach ($aData as $aRow)
  468. $aGrid[] = array(
  469. 'id_row' => $this->_getRowId($aRow),
  470. 'row_class' => $this->_isRowDisabled($aRow) ? 'bx-grid-table-row-disabled bx-def-font-grayed' : '',
  471. 'row' => $this->_getRowDesign($aRow)
  472. );
  473. return $aGrid;
  474. }
  475. protected function _getRowId($mixedRow)
  476. {
  477. if(is_string($mixedRow))
  478. $sId = rand(1, getrandmax());
  479. else
  480. $sId = $mixedRow[$this->_aOptions['field_id']];
  481. return $this->_sObject . '_row_' . $sId;
  482. }
  483. protected function _getRowDesign($mixedRow)
  484. {
  485. $sRow = '';
  486. if(is_string($mixedRow))
  487. $sRow = '<td class="bx-def-padding-sec-topbottom bx-def-font-bold" colspan="' . count($this->_aOptions['fields']) . '">' . $mixedRow . '</td>';
  488. else
  489. foreach($this->_aOptions['fields'] as $sKey => $aField)
  490. $sRow .= $this->_getCellDesign($sKey, $aField, $mixedRow);
  491. return $sRow;
  492. }
  493. protected function _getCellDesign($sKey, $aField, $aRow)
  494. {
  495. $sMethod = '_getCellDefault';
  496. if ($this->_aOptions['field_order'] == $sKey)
  497. $sMethod = '_getCellOrder';
  498. $sCustomMethod = '_getCell' . $this->_genMethodName($sKey);
  499. if (method_exists($this, $sCustomMethod))
  500. $sMethod = $sCustomMethod;
  501. $mixedValue = $this->_getCellData($sKey, $aField, $aRow);
  502. if ($aField['translatable'])
  503. $mixedValue = _t($mixedValue);
  504. $mixedValue = $this->_limitMaxLength($mixedValue, $sKey, $aField, $aRow, $this->_isDisplayPopupOnTextOverflow);
  505. return $this->$sMethod($mixedValue, $sKey, $aField, $aRow);
  506. }
  507. protected function _getCellCheckbox ($mixedValue, $sKey, $aField, $aRow)
  508. {
  509. if($this->_bIsApi)
  510. return ['type' => 'checkbox', 'data' => $aRow[$this->_aOptions['field_id']]];
  511. $sAttr = $this->_convertAttrs(
  512. $aField, 'attr_cell',
  513. 'bx-def-padding-sec-bottom bx-def-padding-sec-top', // add default classes
  514. isset($aField['width']) ? 'width:' . $aField['width'] : false // add default styles
  515. );
  516. $sDisabled = ($this->_isCheckboxDisabled($aRow) ? 'disabled="disabled"' : '');
  517. $sSelected = ($this->_isCheckboxSelected($mixedValue, $sKey, $aField, $aRow) ? 'checked="checked"' : '');
  518. $sVal = $aRow[$this->_aOptions['field_id']];
  519. return '<td ' . $sAttr . '><input type="checkbox" name="'. $this->_sObject . '_check" value="' . $sVal . '" ' . $sDisabled . ' ' . $sSelected . '/></td>';
  520. }
  521. protected function _getCellSwitcher ($mixedValue, $sKey, $aField, $aRow)
  522. {
  523. if($this->_bIsApi)
  524. return ['type' => 'switcher', 'data' => $aRow[$this->_aOptions['field_active']], 'fld' => $this->_aOptions['field_active']];
  525. $sAttr = $this->_convertAttrs(
  526. $aField, 'attr_cell',
  527. 'bx-def-padding-sec-bottom bx-def-padding-sec-top', // add default classes
  528. isset($aField['width']) ? 'width:' . $aField['width'] : false // add default styles
  529. );
  530. $oForm = new BxTemplFormView(array(), $this->_oTemplate);
  531. $oForm->addCssJs();
  532. $aInput = array(
  533. 'type' => 'switcher',
  534. 'name' => $this->_sObject . '_switch_' . $aRow[$this->_aOptions['field_id']],
  535. 'caption' => '',
  536. 'attrs' => array (
  537. 'bx_grid_action_single' => 'enable',
  538. 'bx_grid_action_confirm' => '',
  539. 'bx_grid_action_data' => $aRow[$this->_aOptions['field_id']],
  540. ),
  541. 'value' => $aRow[$this->_aOptions['field_id']],
  542. 'checked' => $this->_isSwitcherOn(isset($aRow[$this->_aOptions['field_active']]) ? $aRow[$this->_aOptions['field_active']] : false, $sKey, $aField, $aRow),
  543. );
  544. $sSwitcher = $oForm->genInput($aInput);
  545. return '<td ' . $sAttr . '>' . $sSwitcher . '</td>';
  546. }
  547. protected function _getCellOrder ($mixedValue, $sKey, $aField, $aRow)
  548. {
  549. if($this->_bIsApi)
  550. return ['type' => 'order', 'data'=> $mixedValue];
  551. $sAttr = $this->_convertAttrs(
  552. $aField, 'attr_cell',
  553. 'bx-def-padding-sec-bottom bx-def-padding-sec-top', // add default classes
  554. isset($aField['width']) ? 'width:' . $aField['width'] : false // add default styles
  555. );
  556. return '<td ' . $sAttr . '><div id="' . $this->_sObject . '_cell_' . $aRow[$this->_aOptions['field_id']] . '" class="bx-grid-drag-handle"><i class="sys-icon align-justify"></i></div></td>';
  557. }
  558. protected function _getCellActions ($mixedValue, $sKey, $aField, $aRow)
  559. {
  560. $sAttr = $this->_convertAttrs(
  561. $aField, 'attr_cell',
  562. 'bx-def-padding-sec-bottom bx-def-padding-sec-top', // add default classes
  563. isset($aField['width']) ? 'width:' . $aField['width'] : false // add default styles
  564. );
  565. $mixedDisabledBehavior = $this->_getActionsDisabledBehavior($aRow);
  566. $mixedActions = $this->_getActions('single', $aRow[$this->_aOptions['field_id']], false, null === $mixedDisabledBehavior ? $this->_isRowDisabled($aRow) : $mixedDisabledBehavior, null !== $mixedDisabledBehavior, $aRow);
  567. if($this->_bIsApi)
  568. return ['type' => 'actions', 'data' => $mixedActions];
  569. return '<td ' . $sAttr . '><div class="bx-grid-cell-single-actions-wrapper bx-def-margin-thd-neg">' . $mixedActions . '</div></td>';
  570. }
  571. protected function _getCellDefault ($mixedValue, $sKey, $aField, $aRow)
  572. {
  573. if($this->_bIsApi)
  574. return ['type' => 'text', 'value'=> $mixedValue];
  575. $sAttr = $this->_convertAttrs(
  576. $aField, 'attr_cell',
  577. 'bx-def-padding-sec-bottom bx-def-padding-sec-top', // add default classes
  578. isset($aField['width']) ? 'width:' . $aField['width'] : false // add default styles
  579. );
  580. return '<td ' . $sAttr . '>' . $mixedValue . '</td>';
  581. }
  582. protected function _getActions ($sType, $sActionData = false, $isSmall = false, $isDisabled = false, $isPermanentState = false, $aRow = array())
  583. {
  584. $sActionsType = 'actions_' . $sType;
  585. if (empty($this->_aOptions[$sActionsType]) || !is_array($this->_aOptions[$sActionsType]))
  586. return '';
  587. $mixedResult = $this->_bIsApi ? [] : '';
  588. foreach ($this->_aOptions[$sActionsType] as $sKey => $a) {
  589. if(!$a['active'] || (!$a['title'] && !$a['icon']))
  590. continue;
  591. $sFunc = '_getAction' . $this->_genMethodName($sKey);
  592. if (!method_exists($this, $sFunc))
  593. $sFunc = empty($a) ? '_getActionDivider' : '_getActionDefault';
  594. if (!isset($a['attr']['bx_grid_action'])) {
  595. $a['attr']['bx_grid_action_' . $sType] = $sKey;
  596. if (!empty($sActionData))
  597. $a['attr']['bx_grid_action_data'] = $sActionData;
  598. if (isset($a['confirm']))
  599. $a['attr']['bx_grid_action_confirm'] = $a['confirm'] ? 1 : 0;
  600. $a['attr']['bx_grid_action_reset_paginate'] = false === strpos($sKey, 'delete') ? 0 : 1; // reset paginate after deleting row
  601. }
  602. if ($isPermanentState && !isset($a['attr']['bx_grid_permanent_state']))
  603. $a['attr']['bx_grid_permanent_state'] = 1;
  604. if ($this->_bIsApi)
  605. $mixedResult[] = $this->$sFunc($sType, $sKey, $a, $isSmall, $isDisabled, $aRow);
  606. else
  607. $mixedResult .= $this->$sFunc($sType, $sKey, $a, $isSmall, $isDisabled, $aRow);
  608. }
  609. return $mixedResult;
  610. }
  611. protected function _getActionsAPI ($sType)
  612. {
  613. $sActionsType = 'actions_' . $sType;
  614. if(empty($this->_aOptions[$sActionsType]) || !is_array($this->_aOptions[$sActionsType]))
  615. return [];
  616. foreach ($this->_aOptions[$sActionsType] as $sKey => $aAction){
  617. $sFunc = '_getAction' . $this->_genMethodName($sType . '_' . $sKey);
  618. if (method_exists($this, $sFunc)){
  619. $this->_aOptions[$sActionsType][$sKey] = $this->$sFunc($aAction);
  620. }
  621. else{
  622. $this->_aOptions[$sActionsType][$sKey]['type'] = 'modal';
  623. $this->_aOptions[$sActionsType][$sKey]['action'] = $sKey;
  624. $this->_aOptions[$sActionsType][$sKey]['params'] = '';
  625. }
  626. }
  627. return $this->_aOptions[$sActionsType];
  628. }
  629. protected function _getActionDelete($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = array())
  630. {
  631. if($this->_bIsApi)
  632. return array_merge($a, ['name' => $sKey, 'type' => 'callback']);
  633. return $this->_getActionDefault($sType, $sKey, $a, $isSmall, $isDisabled, $aRow);
  634. }
  635. protected function _getActionDefault ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = array())
  636. {
  637. if ($a['icon_only'] && empty($a['attr']['title']) && !empty($a['title']))
  638. $a['attr']['title'] = $a['title'];
  639. if ($this->_bIsApi){
  640. $sFunc = '_getAction' . $this->_genMethodName($sType . '_' . $sKey);
  641. if (method_exists($this, $sFunc)){
  642. return array_merge($a, ['name' => $sKey], $this->$sFunc($a, ['id'=> $aRow[$this->_aOptions['field_id']]]));
  643. }
  644. else{
  645. return array_merge($a, ['name' => $sKey, 'type' => 'modal', 'action' => $sKey, 'params' => '&id=' . $aRow[$this->_aOptions['field_id']] ]);
  646. }
  647. }
  648. $sAttr = $this->_convertAttrs(
  649. $a, 'attr',
  650. 'bx-btn bx-def-margin-thd' . ($isSmall ? ' bx-btn-small' : '') . ($isDisabled ? ' bx-btn-disabled' : '') // add default classes
  651. );
  652. $sIcon = '';
  653. $sImage = '';
  654. if (!empty($a['icon'])) {
  655. if (false === strpos($a['icon'], '.'))
  656. $sIcon = '<i class="sys-icon ' . $a['icon'] . '"></i>';
  657. elseif ($sIconUrl = $this->_oTemplate->getIconUrl($a['icon']))
  658. $sImage = '<img style="background-image:url(' . $sIconUrl . ');" src="' . $this->_oTemplate->getIconUrl('spacer.gif') .'" />';
  659. }
  660. return '<button ' . $sAttr . '>' . $sIcon . $sImage . ($a['icon_only'] || empty($a['title']) ? '' : '<u>' . $a['title'] . '</u>') . '</button>';
  661. }
  662. protected function _getActionDivider ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = array())
  663. {
  664. return '<div class="bx-grid-actions-divider bx-def-margin-sec-left"> | </div>';
  665. }
  666. protected function _getFilterControls ()
  667. {
  668. $oForm = new BxTemplFormView(array());
  669. $aInput = array(
  670. 'type' => 'text',
  671. 'name' => 'keyword',
  672. 'attrs' => array(
  673. 'id' => 'bx-grid-search-' . $this->_sObject
  674. )
  675. );
  676. $this->_oTemplate->addCss('forms.css');
  677. return $oForm->genRow($aInput);
  678. }
  679. protected function _getFilterControlsAPI($aFilters = [])
  680. {
  681. if(!empty($this->_aOptions['filter_fields']) || !empty($this->_aOptions['filter_fields_translatable']))
  682. $aFilters['search'] = [];
  683. return $aFilters;
  684. }
  685. protected function _getCounter()
  686. {
  687. return _t('_sys_grid_total_count', $this->_iTotalCount);
  688. }
  689. protected function _limitMaxLength ($mixedValue, $sKey, $aField, $aRow, $isDisplayPopupOnTextOverflow, $bReturnString = true)
  690. {
  691. if ($aField['chars_limit'] > 0)
  692. $mixedValue = BxTemplFunctions::getInstance()->getStringWithLimitedLength($mixedValue, $aField['chars_limit'], $isDisplayPopupOnTextOverflow, $bReturnString);
  693. return $mixedValue;
  694. }
  695. protected function _convertAttrs ($aField, $sAttrName, $sClasses = false, $sStyles = false)
  696. {
  697. if (!empty($aField['hidden_on'])) {
  698. $aHiddenOn = array(
  699. pow(2, BX_DB_HIDDEN_PHONE - 1) => 'bx-def-media-phone-hide',
  700. pow(2, BX_DB_HIDDEN_TABLET - 1) => 'bx-def-media-tablet-hide',
  701. pow(2, BX_DB_HIDDEN_DESKTOP - 1) => 'bx-def-media-desktop-hide',
  702. pow(2, BX_DB_HIDDEN_MOBILE - 1) => 'bx-def-mobile-app-hide'
  703. );
  704. foreach ($aHiddenOn as $iHiddenOn => $sClass)
  705. if ((int)$aField['hidden_on'] & $iHiddenOn)
  706. $sClasses .= ' ' . $sClass;
  707. }
  708. return bx_convert_array2attrs(
  709. isset($aField[$sAttrName]) && is_array($aField[$sAttrName]) ? $aField[$sAttrName] : array(),
  710. $sClasses,
  711. $sStyles
  712. );
  713. }
  714. protected function _updateOrder($mixedId, $iOrder)
  715. {
  716. $oDb = BxDolDb::getInstance();
  717. $sTable = $this->_aOptions['table'];
  718. $sFieldId = $this->_aOptions['field_id'];
  719. $sFieldOrder = $this->_aOptions['field_order'];
  720. $sQuery = $oDb->prepare("UPDATE `{$sTable}` SET `{$sFieldOrder}` = ? WHERE `{$sFieldId}` = ?", $iOrder, $mixedId);
  721. return $oDb->query($sQuery);
  722. }
  723. protected function _delete ($mixedId)
  724. {
  725. $oDb = BxDolDb::getInstance();
  726. $sTable = $this->_aOptions['table'];
  727. $sFieldId = $this->_aOptions['field_id'];
  728. $sQuery = $oDb->prepare("DELETE FROM `{$sTable}` WHERE `{$sFieldId}` = ?", $mixedId);
  729. return $oDb->query($sQuery);
  730. }
  731. protected function _enable ($mixedId, $isChecked)
  732. {
  733. $oDb = BxDolDb::getInstance();
  734. $sTable = $this->_aOptions['table'];
  735. $sFieldId = $this->_aOptions['field_id'];
  736. $sFieldActive = $this->_aOptions['field_active'];
  737. $sQuery = $oDb->prepare("UPDATE `{$sTable}` SET `$sFieldActive` = ? WHERE `{$sFieldId}` = ?", $this->_switcherChecked2State($isChecked), $mixedId);
  738. return $oDb->query($sQuery);
  739. }
  740. protected function _addJsCss()
  741. {
  742. if ($this->_aOptions['field_order']) {
  743. $this->_oTemplate->addJs(array(
  744. 'jquery-ui/jquery-ui.custom.min.js',
  745. 'URI.min.js',
  746. ));
  747. }
  748. $this->_oTemplate->addJs('BxDolGrid.js');
  749. $this->_oTemplate->addCss('grid.css');
  750. $this->_oTemplate->addJsTranslation('_sys_grid_confirmation');
  751. }
  752. }
  753. /** @} */