BxBaseModGeneralModule.php 58 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509
  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 BaseGeneral Base classes for modules
  7. * @ingroup UnaModules
  8. *
  9. * @{
  10. */
  11. bx_import('BxDolAcl');
  12. /**
  13. * Base module class.
  14. */
  15. class BxBaseModGeneralModule extends BxDolModule
  16. {
  17. protected $_iProfileId;
  18. protected $_aSearchableNamesExcept;
  19. protected $_aFormParams;
  20. function __construct(&$aModule)
  21. {
  22. parent::__construct($aModule);
  23. $this->_iProfileId = bx_get_logged_profile_id();
  24. $this->_aSearchableNamesExcept = array(
  25. 'allow_view_to'
  26. );
  27. $this->_aFormParams = array(
  28. 'display' => false,
  29. 'dynamic_mode' => false,
  30. 'ajax_mode' => false,
  31. 'absolute_action_url' => false,
  32. 'visibility_autoselect' => false,
  33. 'context_id' => 0,
  34. );
  35. }
  36. // ====== ACTIONS METHODS
  37. public function actionRss ()
  38. {
  39. $aArgs = func_get_args();
  40. $this->_rss($aArgs);
  41. }
  42. public function actionGetCreatePostForm()
  43. {
  44. $aParams = bx_process_input(array_intersect_key($_GET, $this->_aFormParams));
  45. $aParams = array_merge($this->_aFormParams, $aParams);
  46. $sForm = $this->serviceGetCreatePostForm($aParams);
  47. if(empty($sForm))
  48. return echoJson(array());
  49. return echoJson(array(
  50. 'module' => $this->_oConfig->getName(),
  51. 'content' => $sForm
  52. ));
  53. }
  54. // ====== SERVICE METHODS
  55. public function serviceGetCreatePostForm($aParams = array())
  56. {
  57. $aParams = array_merge($this->_aFormParams, $aParams);
  58. $oForm = $this->serviceGetObjectForm('add', $aParams);
  59. if(!$oForm)
  60. return '';
  61. return $this->serviceEntityCreate($aParams);
  62. }
  63. public function serviceGetAuthor ($iContentId)
  64. {
  65. $mixedResult = $this->_getFieldValue('FIELD_AUTHOR', $iContentId);
  66. return $mixedResult !== false ? (int)$mixedResult : 0;
  67. }
  68. public function serviceGetDateAdded ($iContentId)
  69. {
  70. $mixedResult = $this->_getFieldValue('FIELD_ADDED', $iContentId);
  71. return $mixedResult !== false ? (int)$mixedResult : 0;
  72. }
  73. public function serviceGetDateChanged ($iContentId)
  74. {
  75. $mixedResult = $this->_getFieldValue('FIELD_CHANGED', $iContentId);
  76. return $mixedResult !== false ? (int)$mixedResult : 0;
  77. }
  78. public function serviceGetLink ($iContentId)
  79. {
  80. $CNF = &$this->_oConfig->CNF;
  81. if(empty($CNF['URI_VIEW_ENTRY']))
  82. return '';
  83. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  84. if(empty($aContentInfo))
  85. return '';
  86. return BX_DOL_URL_ROOT . BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]);
  87. }
  88. public function serviceGetTitle ($iContentId)
  89. {
  90. $mixedResult = $this->_getFieldValue('FIELD_TITLE', $iContentId);
  91. return $mixedResult !== false ? $mixedResult : '';
  92. }
  93. public function serviceGetText ($iContentId)
  94. {
  95. $mixedResult = $this->_getFieldValue('FIELD_TEXT', $iContentId);
  96. if (false === $mixedResult)
  97. return '';
  98. $CNF = &$this->_oConfig->CNF;
  99. if (!empty($CNF['OBJECT_METATAGS']) && is_string($mixedResult)) {
  100. $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']);
  101. $mixedResult = $oMetatags->metaParse($iContentId, $mixedResult);
  102. }
  103. return $mixedResult;
  104. }
  105. public function serviceGetInfo ($iContentId, $bSearchableFieldsOnly = true)
  106. {
  107. $CNF = &$this->_oConfig->CNF;
  108. $aContentInfo = $this->_getFields($iContentId);
  109. if(empty($aContentInfo))
  110. return array();
  111. if(!$bSearchableFieldsOnly)
  112. return $aContentInfo;
  113. if(empty($CNF['PARAM_SEARCHABLE_FIELDS']))
  114. return array();
  115. $aFields = explode(',', getParam($CNF['PARAM_SEARCHABLE_FIELDS']));
  116. if(empty($aFields))
  117. return array();
  118. $aResult = array();
  119. foreach($aFields as $sField)
  120. if(isset($aContentInfo[$sField]))
  121. $aResult[$sField] = $aContentInfo[$sField];
  122. return $aResult;
  123. }
  124. public function serviceGetSearchResultUnit ($iContentId, $sUnitTemplate = '')
  125. {
  126. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  127. if(empty($aContentInfo))
  128. return '';
  129. if(empty($sUnitTemplate))
  130. $sUnitTemplate = 'unit.html';
  131. return $this->_oTemplate->unit($aContentInfo, true, $sUnitTemplate);
  132. }
  133. public function serviceGetAll ($aParams = array())
  134. {
  135. if(empty($aParams) || !is_array($aParams))
  136. $aParams = array('type' => 'all');
  137. return $this->_oDb->getEntriesBy($aParams);
  138. }
  139. public function serviceGetAllByAuthor ($iProfileId)
  140. {
  141. return $this->_oDb->getEntriesByAuthor((int)$iProfileId);
  142. }
  143. public function serviceGetSearchableFieldsExtended()
  144. {
  145. $CNF = &$this->_oConfig->CNF;
  146. if(empty($CNF['OBJECT_FORM_ENTRY']))
  147. return array();
  148. $aResult = array();
  149. if(!empty($CNF['FIELD_AUTHOR']) && !in_array($CNF['FIELD_AUTHOR'], $this->_aSearchableNamesExcept))
  150. $aResult[$CNF['FIELD_AUTHOR']] = array(
  151. 'type' => 'text_auto',
  152. 'caption' => $CNF['T']['form_field_author'],
  153. 'info' => '',
  154. 'value' => '',
  155. 'values' => '',
  156. 'pass' => ''
  157. );
  158. $aInputs = array();
  159. if(!empty($CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'])) {
  160. $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ENTRY'], $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'], $this->_oTemplate);
  161. $aInputs = array_merge($aInputs, $oForm->aInputs);
  162. }
  163. if(!empty($CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT'])) {
  164. $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ENTRY'], $CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT'], $this->_oTemplate);
  165. $aInputs = array_merge($aInputs, $oForm->aInputs);
  166. }
  167. foreach($aInputs as $aInput)
  168. if(in_array($aInput['type'], BxDolSearchExtended::$SEARCHABLE_TYPES) && !in_array($aInput['name'], $this->_aSearchableNamesExcept))
  169. $aResult[$aInput['name']] = array(
  170. 'type' => $aInput['type'],
  171. 'caption_system' => $aInput['caption_system_src'],
  172. 'caption' => $aInput['caption_src'],
  173. 'info' => $aInput['info_src'],
  174. 'value' => !empty($aInput['value']) ? $aInput['value'] : '',
  175. 'values' => !empty($aInput['values_src']) ? $aInput['values_src'] : '',
  176. 'pass' => !empty($aInput['db']['pass']) ? $aInput['db']['pass'] : '',
  177. );
  178. return $aResult;
  179. }
  180. public function serviceGetSearchResultExtended($aParams, $iStart = 0, $iPerPage = 0)
  181. {
  182. if(empty($aParams) || !is_array($aParams))
  183. return array();
  184. return $this->_oDb->getEntriesBy(array('type' => 'search_ids', 'search_params' => $aParams, 'start' => $iStart, 'per_page' => $iPerPage));
  185. }
  186. public function serviceModuleIcon ()
  187. {
  188. return isset($this->_oConfig->CNF['ICON']) ? $this->_oConfig->CNF['ICON'] : '';
  189. }
  190. public function serviceGetSearchableFields ()
  191. {
  192. $CNF = $this->_oConfig->CNF;
  193. if (!isset($CNF['PARAM_SEARCHABLE_FIELDS']) || !isset($CNF['OBJECT_FORM_ENTRY']) || !isset($CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD']))
  194. return array();
  195. $aTextTypes = array('text', 'textarea');
  196. $aTextFields = array();
  197. $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ENTRY'], $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'], $this->_oTemplate);
  198. foreach ($oForm->aInputs as $r) {
  199. if (in_array($r['type'], $aTextTypes))
  200. $aTextFields[$r['name']] = $r['caption'];
  201. }
  202. return $aTextFields;
  203. }
  204. public function serviceManageTools($sType = 'common')
  205. {
  206. $oGrid = BxDolGrid::getObjectInstance($this->_oConfig->getGridObject($sType));
  207. if(!$oGrid)
  208. return '';
  209. $CNF = &$this->_oConfig->CNF;
  210. $sMenu = '';
  211. if(BxDolAcl::getInstance()->isMemberLevelInSet(192)) {
  212. $oPermalink = BxDolPermalinks::getInstance();
  213. $aMenuItems = array();
  214. if(!empty($CNF['OBJECT_GRID_COMMON']) && !empty($CNF['T']['menu_item_manage_my']))
  215. $aMenuItems[] = array('id' => 'manage-common', 'name' => 'manage-common', 'class' => '', 'link' => $oPermalink->permalink($CNF['URL_MANAGE_COMMON']), 'target' => '_self', 'title' => _t($CNF['T']['menu_item_manage_my']), 'active' => 1);
  216. if(!empty($CNF['OBJECT_GRID_ADMINISTRATION']) && !empty($CNF['T']['menu_item_manage_all']))
  217. $aMenuItems[] = array('id' => 'manage-administration', 'name' => 'manage-administration', 'class' => '', 'link' => $oPermalink->permalink($CNF['URL_MANAGE_ADMINISTRATION']), 'target' => '_self', 'title' => _t($CNF['T']['menu_item_manage_all']), 'active' => 1);
  218. if(count($aMenuItems) > 1) {
  219. $oMenu = new BxTemplMenu(array(
  220. 'template' => 'menu_vertical.html',
  221. 'menu_items' => $aMenuItems
  222. ), $this->_oTemplate);
  223. $oMenu->setSelected($this->_aModule['name'], 'manage-' . $sType);
  224. $sMenu = $oMenu->getCode();
  225. }
  226. }
  227. if(!empty($CNF['OBJECT_MENU_SUBMENU']) && isset($CNF['URI_MANAGE_COMMON'])) {
  228. BxDolMenu::getObjectInstance($CNF['OBJECT_MENU_SUBMENU'])->setSelected($this->_aModule['name'], $CNF['URI_MANAGE_COMMON']);
  229. }
  230. $this->_oTemplate->addCss(array('manage_tools.css'));
  231. $this->_oTemplate->addJs(array('manage_tools.js'));
  232. $this->_oTemplate->addJsTranslation(array('_sys_grid_search'));
  233. return array(
  234. 'content' => $this->_oTemplate->getJsCode('manage_tools', array('sObjNameGrid' => $this->_oConfig->getGridObject($sType))) . $oGrid->getCode(),
  235. 'menu' => $sMenu
  236. );
  237. }
  238. public function serviceGetMenuAddonManageTools()
  239. {
  240. return 0;
  241. }
  242. public function serviceGetMenuAddonManageToolsProfileStats()
  243. {
  244. return 0;
  245. }
  246. /**
  247. * My entries actions block
  248. */
  249. public function serviceMyEntriesActions ($iProfileId = 0)
  250. {
  251. $CNF = &$this->_oConfig->CNF;
  252. if(empty($CNF['OBJECT_MENU_ACTIONS_MY_ENTRIES']))
  253. return false;
  254. if (!$iProfileId)
  255. $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT);
  256. if (!$iProfileId || !($oProfile = BxDolProfile::getInstance($iProfileId)))
  257. return false;
  258. if ($iProfileId != $this->_iProfileId)
  259. return false;
  260. $oMenu = BxTemplMenu::getObjectInstance($CNF['OBJECT_MENU_ACTIONS_MY_ENTRIES']);
  261. return $oMenu ? $oMenu->getCode() : false;
  262. }
  263. /**
  264. * Universal browse method
  265. * @param $aParams custom browse params, possible params are the following:
  266. * - mode - browse mode, such as 'recent', 'featured', etc
  267. * - params - custom params to browse method, for example 'unit_view' can be passed here
  268. * - design_box - design box style, @see BxBaseFunctions::DesignBoxContent
  269. * - empty_message - display or not "empty" message when there is no content
  270. * - ajax_paginate - use AJAX paginate or not
  271. * @return HTML string
  272. */
  273. public function serviceBrowse ($aParams = array())
  274. {
  275. $aDefaults = array (
  276. 'mode' => 'recent',
  277. 'params' => false,
  278. 'design_box' => BX_DB_PADDING_DEF,
  279. 'empty_message' => false,
  280. 'ajax_paginate' => true,
  281. );
  282. $aParams = array_merge($aDefaults, $aParams);
  283. return $this->_serviceBrowse ($aParams['mode'], $aParams['params'], $aParams['design_box'], $aParams['empty_message'], $aParams['ajax_paginate']);
  284. }
  285. /**
  286. * Display featured entries
  287. * @return HTML string
  288. */
  289. public function serviceBrowseFeatured ($sUnitView = false, $bEmptyMessage = false, $bAjaxPaginate = true)
  290. {
  291. return $this->_serviceBrowse ('featured', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate);
  292. }
  293. /**
  294. * Display entries favored by a member
  295. * @return HTML string
  296. */
  297. public function serviceBrowseFavorite ($iProfileId = 0, $aParams = array())
  298. {
  299. $oProfile = null;
  300. if((int)$iProfileId)
  301. $oProfile = BxDolProfile::getInstance($iProfileId);
  302. if(!$oProfile && bx_get('profile_id') !== false)
  303. $oProfile = BxDolProfile:: getInstance(bx_process_input(bx_get('profile_id'), BX_DATA_INT));
  304. if(!$oProfile)
  305. $oProfile = BxDolProfile::getInstance();
  306. if(!$oProfile)
  307. return '';
  308. $bEmptyMessage = false;
  309. if(isset($aParams['empty_message'])) {
  310. $bEmptyMessage = (bool)$aParams['empty_message'];
  311. unset($aParams['empty_message']);
  312. }
  313. return $this->_serviceBrowse ('favorite', array_merge(array('user' => $oProfile->id()), $aParams), BX_DB_PADDING_DEF, $bEmptyMessage);
  314. }
  315. public function serviceFormsHelper ()
  316. {
  317. bx_import('FormsEntryHelper', $this->_aModule);
  318. $sClass = $this->_aModule['class_prefix'] . 'FormsEntryHelper';
  319. return new $sClass($this);
  320. }
  321. /**
  322. * Add entry using provided fields' values.
  323. * @return HTML string
  324. */
  325. public function serviceEntityAdd ($iProfile, $aValues)
  326. {
  327. bx_import('FormsEntryHelper', $this->_aModule);
  328. $sClass = $this->_aModule['class_prefix'] . 'FormsEntryHelper';
  329. $oFormsHelper = new $sClass($this);
  330. return $oFormsHelper->addData($iProfile, $aValues);
  331. }
  332. /**
  333. * Perform redirect after content creation
  334. * @return nothing, rediret header is sent
  335. */
  336. public function serviceRedirectAfterAdd($aContentInfo)
  337. {
  338. bx_import('FormsEntryHelper', $this->_aModule);
  339. $sClass = $this->_aModule['class_prefix'] . 'FormsEntryHelper';
  340. $oFormsHelper = new $sClass($this);
  341. $oFormsHelper->redirectAfterAdd($aContentInfo);
  342. }
  343. /**
  344. * Get form object for add, edit, view or delete the content
  345. * @param $sType 'add', 'edit', 'view' or 'delete'
  346. * @param $aParams optional array with parameters(display name, etc)
  347. * @return form object or false on error
  348. */
  349. public function serviceGetObjectForm ($sType, $aParams = array())
  350. {
  351. if (!in_array($sType, array('add', 'edit', 'view', 'delete')))
  352. return false;
  353. $CNF = &$this->_oConfig->CNF;
  354. bx_import('FormsEntryHelper', $this->_aModule);
  355. $sClass = $this->_aModule['class_prefix'] . 'FormsEntryHelper';
  356. $oFormsHelper = new $sClass($this);
  357. $sDisplay = !empty($aParams['display']) ? $aParams['display'] : false;
  358. $sFunc = 'getObjectForm' . ucfirst($sType);
  359. $oForm = $oFormsHelper->$sFunc($sDisplay);
  360. $sParamsKey = 'absolute_action_url';
  361. if(isset($aParams[$sParamsKey]) && (bool)$aParams[$sParamsKey] === true) {
  362. $sKeyUri = 'URI_' . strtoupper($sType) . '_ENTRY';
  363. if(!empty($this->_oConfig->CNF[$sKeyUri]))
  364. $oForm->aFormAttrs['action'] = BX_DOL_URL_ROOT . BxDolPermalinks::getInstance()->permalink('page.php?i=' . $this->_oConfig->CNF[$sKeyUri]);
  365. }
  366. $sParamsKey = 'ajax_mode';
  367. if(isset($aParams[$sParamsKey]) && is_bool($aParams[$sParamsKey]))
  368. $oForm->setAjaxMode((bool)$aParams[$sParamsKey]);
  369. $sKey = 'FIELD_ALLOW_VIEW_TO';
  370. if(!empty($aParams['context_id']) && !empty($CNF[$sKey]) && !empty($oForm->aInputs[$CNF[$sKey]])) {
  371. foreach($oForm->aInputs[$CNF[$sKey]]['values'] as $aValue)
  372. if(isset($aValue['key']) && (int)$aValue['key'] == -(int)$aParams['context_id']) {
  373. $oForm->aInputs[$CNF[$sKey]]['value'] = -(int)$aParams['context_id'];
  374. $oForm->aInputs[$CNF[$sKey]]['type'] = 'hidden';
  375. break;
  376. }
  377. }
  378. return $oForm;
  379. }
  380. /**
  381. * Create entry form
  382. * @return HTML string
  383. */
  384. public function serviceEntityCreate ($sParams = false)
  385. {
  386. $bParamsArray = is_array($sParams);
  387. $sDisplay = is_string($sParams) ? $sParams : false;
  388. if($bParamsArray && !empty($sParams['display']))
  389. $sDisplay = $sParams['display'];
  390. bx_import('FormsEntryHelper', $this->_aModule);
  391. $sClass = $this->_aModule['class_prefix'] . 'FormsEntryHelper';
  392. $oFormsHelper = new $sClass($this);
  393. if($bParamsArray && isset($sParams['dynamic_mode']))
  394. $oFormsHelper->setDynamicMode($sParams['dynamic_mode']);
  395. return $oFormsHelper->addDataForm($sDisplay);
  396. }
  397. public function serviceEntityEdit ($iContentId = 0, $sDisplay = false)
  398. {
  399. return $this->_serviceEntityForm ('editDataForm', $iContentId, $sDisplay);
  400. }
  401. public function serviceEntityDelete ($iContentId = 0)
  402. {
  403. return $this->_serviceEntityForm ('deleteDataForm', $iContentId);
  404. }
  405. public function serviceEntityTextBlock ($iContentId = 0)
  406. {
  407. return $this->_serviceEntityForm ('viewDataEntry', $iContentId);
  408. }
  409. public function serviceEntityInfo ($iContentId = 0, $sDisplay = false)
  410. {
  411. return $this->_serviceEntityForm ('viewDataForm', $iContentId, $sDisplay);
  412. }
  413. public function serviceEntityInfoFull ($iContentId = 0)
  414. {
  415. $CNF = &$this->_oConfig->CNF;
  416. $sDisplayName = 'OBJECT_FORM_ENTRY_DISPLAY_VIEW_FULL';
  417. return $this->_serviceEntityForm ('viewDataForm', $iContentId, !empty($CNF[$sDisplayName]) ? $CNF[$sDisplayName] : false);
  418. }
  419. public function serviceEntityInfoExtended ($iContentId = 0)
  420. {
  421. return $this->_serviceTemplateFunc ('entryInfo', $iContentId);
  422. }
  423. /**
  424. * Entry location info
  425. */
  426. public function serviceEntityLocation ($iContentId = 0)
  427. {
  428. $iContentId = $this->_getContent($iContentId, false);
  429. if($iContentId === false)
  430. return false;
  431. return $this->_oTemplate->entryLocation ($iContentId);
  432. }
  433. /**
  434. * Entry comments
  435. */
  436. public function serviceEntityComments ($iContentId = 0)
  437. {
  438. $CNF = &$this->_oConfig->CNF;
  439. if(empty($CNF['OBJECT_COMMENTS']))
  440. return '';
  441. return $this->_entityComments($CNF['OBJECT_COMMENTS'], $iContentId);
  442. }
  443. /**
  444. * Entry attachments block
  445. */
  446. public function serviceEntityAttachments ($iContentId = 0)
  447. {
  448. return $this->_serviceTemplateFunc ('entryAttachments', $iContentId);
  449. }
  450. /**
  451. * Delete content entry
  452. * @param $iContentId content id
  453. * @return error message or empty string on success
  454. */
  455. public function serviceDeleteEntity ($iContentId, $sFuncDelete = 'deleteData')
  456. {
  457. bx_import('FormsEntryHelper', $this->_aModule);
  458. $sClass = $this->_oConfig->getClassPrefix() . 'FormsEntryHelper';
  459. $oFormsHelper = new $sClass($this);
  460. return $oFormsHelper->$sFuncDelete($iContentId);
  461. }
  462. /**
  463. * Entry actions and social sharing block
  464. */
  465. public function serviceEntityAllActions ($iContentId = 0)
  466. {
  467. return $this->_oTemplate->entryAllActions($this->serviceEntityActions($iContentId), $this->serviceEntitySocialSharing($iContentId));
  468. }
  469. /**
  470. * Entry actions block
  471. */
  472. public function serviceEntityActions ($iContentId = 0)
  473. {
  474. $iContentId = $this->_getContent($iContentId, false);
  475. if($iContentId === false)
  476. return false;
  477. $oMenu = BxTemplMenu::getObjectInstance($this->_oConfig->CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY']);
  478. return $oMenu ? $oMenu->getCode() : false;
  479. }
  480. /**
  481. * Entry social sharing block
  482. */
  483. public function serviceEntitySocialSharing ($iContentId = 0)
  484. {
  485. $mixedContent = $this->_getContent($iContentId);
  486. if($mixedContent === false)
  487. return false;
  488. list($iContentId, $aContentInfo) = $mixedContent;
  489. $CNF = &$this->_oConfig->CNF;
  490. return $this->_entitySocialSharing ($iContentId, array(
  491. 'id_timeline' => $iContentId,
  492. 'id_thumb' => !empty($CNF['FIELD_THUMB']) && !empty($aContentInfo[$CNF['FIELD_THUMB']]) ? $aContentInfo[$CNF['FIELD_THUMB']] : '',
  493. 'title' => !empty($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : '',
  494. 'object_storage' => !empty($CNF['OBJECT_STORAGE']) ? $CNF['OBJECT_STORAGE'] : '',
  495. 'object_transcoder' => false,
  496. 'object_view' => !empty($CNF['OBJECT_VIEWS']) ? $CNF['OBJECT_VIEWS'] : '',
  497. 'object_vote' => !empty($CNF['OBJECT_VOTES']) ? $CNF['OBJECT_VOTES'] : '',
  498. 'object_score' => !empty($CNF['OBJECT_SCORES']) ? $CNF['OBJECT_SCORES'] : '',
  499. 'object_favorite' => !empty($CNF['OBJECT_FAVORITES']) ? $CNF['OBJECT_FAVORITES'] : '',
  500. 'object_feature' => !empty($CNF['OBJECT_FEATURED']) ? $CNF['OBJECT_FEATURED'] : '',
  501. 'object_report' => !empty($CNF['OBJECT_REPORTS']) ? $CNF['OBJECT_REPORTS'] : '',
  502. 'uri_view_entry' => !empty($CNF['URI_VIEW_ENTRY']) ? $CNF['URI_VIEW_ENTRY'] : '',
  503. ));
  504. }
  505. /**
  506. * Data for Notifications module
  507. */
  508. public function serviceGetNotificationsData()
  509. {
  510. $sModule = $this->_aModule['name'];
  511. $sEventPrivacy = $sModule . '_allow_view_event_to';
  512. if(BxDolPrivacy::getObjectInstance($sEventPrivacy) === false)
  513. $sEventPrivacy = '';
  514. return array(
  515. 'handlers' => array(
  516. array('group' => $sModule . '_object', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'added', 'module_name' => $sModule, 'module_method' => 'get_notifications_post', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy),
  517. array('group' => $sModule . '_object', 'type' => 'update', 'alert_unit' => $sModule, 'alert_action' => 'edited'),
  518. array('group' => $sModule . '_object', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'deleted'),
  519. array('group' => $sModule . '_comment', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'commentPost', 'module_name' => $sModule, 'module_method' => 'get_notifications_comment', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy),
  520. array('group' => $sModule . '_comment', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'commentRemoved'),
  521. array('group' => $sModule . '_reply', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'replyPost', 'module_name' => $sModule, 'module_method' => 'get_notifications_reply', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy),
  522. array('group' => $sModule . '_reply', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'replyRemoved'),
  523. array('group' => $sModule . '_vote', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'doVote', 'module_name' => $sModule, 'module_method' => 'get_notifications_vote', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy),
  524. array('group' => $sModule . '_vote', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'undoVote'),
  525. ),
  526. 'alerts' => array(
  527. array('unit' => $sModule, 'action' => 'added'),
  528. array('unit' => $sModule, 'action' => 'edited'),
  529. array('unit' => $sModule, 'action' => 'deleted'),
  530. array('unit' => $sModule, 'action' => 'commentPost'),
  531. array('unit' => $sModule, 'action' => 'commentRemoved'),
  532. array('unit' => $sModule, 'action' => 'replyPost'),
  533. array('unit' => $sModule, 'action' => 'replyRemoved'),
  534. array('unit' => $sModule, 'action' => 'doVote'),
  535. array('unit' => $sModule, 'action' => 'undoVote'),
  536. )
  537. );
  538. }
  539. /**
  540. * Entry post for Notifications module
  541. */
  542. public function serviceGetNotificationsPost($aEvent)
  543. {
  544. $CNF = &$this->_oConfig->CNF;
  545. $aContentInfo = $this->_oDb->getContentInfoById($aEvent['object_id']);
  546. if(empty($aContentInfo) || !is_array($aContentInfo))
  547. return array();
  548. $sEntryUrl = BX_DOL_URL_ROOT . BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]);
  549. $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...');
  550. return array(
  551. 'entry_sample' => $CNF['T']['txt_sample_single'],
  552. 'entry_url' => $sEntryUrl,
  553. 'entry_caption' => $sEntryCaption,
  554. 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']],
  555. 'entry_privacy' => '', //may be empty or not specified. In this case Public privacy will be used.
  556. 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used.
  557. );
  558. }
  559. /**
  560. * Entry post comment for Notifications module
  561. */
  562. public function serviceGetNotificationsComment($aEvent)
  563. {
  564. $CNF = &$this->_oConfig->CNF;
  565. $iContentId = (int)$aEvent['object_id'];
  566. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  567. if(empty($aContentInfo) || !is_array($aContentInfo))
  568. return array();
  569. $oComment = BxDolCmts::getObjectInstance($CNF['OBJECT_COMMENTS'], $iContentId);
  570. if(!$oComment || !$oComment->isEnabled())
  571. return array();
  572. $sEntryUrl = BX_DOL_URL_ROOT . BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]);
  573. $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...');
  574. return array(
  575. 'entry_sample' => $CNF['T']['txt_sample_single'],
  576. 'entry_url' => $sEntryUrl,
  577. 'entry_caption' => $sEntryCaption,
  578. 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']],
  579. 'subentry_sample' => $CNF['T']['txt_sample_comment_single'],
  580. 'subentry_url' => $oComment->getViewUrl((int)$aEvent['subobject_id']),
  581. 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used.
  582. );
  583. }
  584. /**
  585. * Entry post reply for Notifications module
  586. */
  587. public function serviceGetNotificationsReply($aEvent)
  588. {
  589. $CNF = &$this->_oConfig->CNF;
  590. $oComment = BxDolCmts::getObjectInstance($CNF['OBJECT_COMMENTS'], 0, false);
  591. if(!$oComment || !$oComment->isEnabled())
  592. return array();
  593. $iParentId = (int)$aEvent['object_id'];
  594. $aParentInfo = $oComment->getQueryObject()->getCommentsBy(array('type' => 'id', 'id' => $iParentId));
  595. if(empty($aParentInfo) || !is_array($aParentInfo))
  596. return array();
  597. $iObjectId = (int)$aParentInfo['cmt_object_id'];
  598. $oComment->init($iObjectId);
  599. return array(
  600. 'object_id' => $iObjectId,
  601. 'entry_sample' => '_cmt_txt_sample_comment_single',
  602. 'entry_url' => $oComment->getViewUrl($iParentId),
  603. 'entry_caption' => strmaxtextlen($aParentInfo['cmt_text'], 20, '...'),
  604. 'entry_author' => (int)$aParentInfo['cmt_author_id'],
  605. 'subentry_sample' => '_cmt_txt_sample_reply_to',
  606. 'subentry_url' => $oComment->getViewUrl((int)$aEvent['subobject_id']),
  607. 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used.
  608. );
  609. }
  610. /**
  611. * Entry post vote for Notifications module
  612. */
  613. public function serviceGetNotificationsVote($aEvent)
  614. {
  615. $CNF = &$this->_oConfig->CNF;
  616. $iContentId = (int)$aEvent['object_id'];
  617. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  618. if(empty($aContentInfo) || !is_array($aContentInfo))
  619. return array();
  620. $oVote = BxDolVote::getObjectInstance($CNF['OBJECT_VOTES'], $iContentId);
  621. if(!$oVote || !$oVote->isEnabled())
  622. return array();
  623. $sEntryUrl = BX_DOL_URL_ROOT . BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]);
  624. $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...');
  625. return array(
  626. 'entry_sample' => $CNF['T']['txt_sample_single'],
  627. 'entry_url' => $sEntryUrl,
  628. 'entry_caption' => $sEntryCaption,
  629. 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']],
  630. 'subentry_sample' => $CNF['T']['txt_sample_vote_single'],
  631. 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used.
  632. );
  633. }
  634. /**
  635. * Data for Timeline module
  636. */
  637. public function serviceGetTimelineData()
  638. {
  639. $sModule = $this->_aModule['name'];
  640. return array(
  641. 'handlers' => array(
  642. array('group' => $sModule . '_object', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'added', 'module_name' => $sModule, 'module_method' => 'get_timeline_post', 'module_class' => 'Module', 'groupable' => 0, 'group_by' => ''),
  643. array('group' => $sModule . '_object', 'type' => 'update', 'alert_unit' => $sModule, 'alert_action' => 'edited'),
  644. array('group' => $sModule . '_object', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'deleted')
  645. ),
  646. 'alerts' => array(
  647. array('unit' => $sModule, 'action' => 'added'),
  648. array('unit' => $sModule, 'action' => 'edited'),
  649. array('unit' => $sModule, 'action' => 'deleted'),
  650. )
  651. );
  652. }
  653. /**
  654. * Entry post for Timeline module
  655. */
  656. public function serviceGetTimelinePost($aEvent, $aBrowseParams = array())
  657. {
  658. $aContentInfo = $this->_oDb->getContentInfoById($aEvent['object_id']);
  659. if(empty($aContentInfo) || !is_array($aContentInfo))
  660. return '';
  661. $CNF = &$this->_oConfig->CNF;
  662. //--- Views
  663. $oViews = isset($CNF['OBJECT_VIEWS']) ? BxDolView::getObjectInstance($CNF['OBJECT_VIEWS'], $aEvent['object_id']) : null;
  664. $aViews = array();
  665. if ($oViews && $oViews->isEnabled())
  666. $aViews = array(
  667. 'system' => $CNF['OBJECT_VIEWS'],
  668. 'object_id' => $aContentInfo[$CNF['FIELD_ID']],
  669. 'count' => $aContentInfo['views']
  670. );
  671. //--- Votes
  672. $oVotes = isset($CNF['OBJECT_VOTES']) ? BxDolVote::getObjectInstance($CNF['OBJECT_VOTES'], $aEvent['object_id']) : null;
  673. $aVotes = array();
  674. if ($oVotes && $oVotes->isEnabled())
  675. $aVotes = array(
  676. 'system' => $CNF['OBJECT_VOTES'],
  677. 'object_id' => $aContentInfo[$CNF['FIELD_ID']],
  678. 'count' => $aContentInfo['votes']
  679. );
  680. //--- Scores
  681. $oScores = isset($CNF['OBJECT_SCORES']) ? BxDolScore::getObjectInstance($CNF['OBJECT_SCORES'], $aEvent['object_id']) : null;
  682. $aScores = array();
  683. if ($oScores && $oScores->isEnabled())
  684. $aScores = array(
  685. 'system' => $CNF['OBJECT_SCORES'],
  686. 'object_id' => $aContentInfo[$CNF['FIELD_ID']],
  687. 'score' => $aContentInfo['score']
  688. );
  689. //--- Reports
  690. $oReports = isset($CNF['OBJECT_REPORTS']) ? BxDolReport::getObjectInstance($CNF['OBJECT_REPORTS'], $aEvent['object_id']) : null;
  691. $aReports = array();
  692. if ($oReports && $oReports->isEnabled())
  693. $aReports = array(
  694. 'system' => $CNF['OBJECT_REPORTS'],
  695. 'object_id' => $aContentInfo[$CNF['FIELD_ID']],
  696. 'count' => $aContentInfo['reports']
  697. );
  698. //--- Comments
  699. $oCmts = isset($CNF['OBJECT_COMMENTS']) ? BxDolCmts::getObjectInstance($CNF['OBJECT_COMMENTS'], $aEvent['object_id']) : null;
  700. $aComments = array();
  701. if($oCmts && $oCmts->isEnabled())
  702. $aComments = array(
  703. 'system' => $CNF['OBJECT_COMMENTS'],
  704. 'object_id' => $aContentInfo[$CNF['FIELD_ID']],
  705. 'count' => $aContentInfo['comments']
  706. );
  707. //--- Title & Description
  708. $sTitle = !empty($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : '';
  709. if(empty($sTitle) && !empty($aContentInfo[$CNF['FIELD_TEXT']]))
  710. $sTitle = $aContentInfo[$CNF['FIELD_TEXT']];
  711. return array(
  712. 'owner_id' => $aContentInfo[$CNF['FIELD_AUTHOR']],
  713. 'icon' => !empty($CNF['ICON']) ? $CNF['ICON'] : '',
  714. 'sample' => isset($CNF['T']['txt_sample_single_with_article']) ? $CNF['T']['txt_sample_single_with_article'] : $CNF['T']['txt_sample_single'],
  715. 'sample_wo_article' => $CNF['T']['txt_sample_single'],
  716. 'sample_action' => isset($CNF['T']['txt_sample_action']) ? $CNF['T']['txt_sample_action'] : '',
  717. 'url' => BX_DOL_URL_ROOT . BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]),
  718. 'content' => $this->_getContentForTimelinePost($aEvent, $aContentInfo, $aBrowseParams), //a string to display or array to parse default template before displaying.
  719. 'date' => $aContentInfo[$CNF['FIELD_ADDED']],
  720. 'views' => $aViews,
  721. 'votes' => $aVotes,
  722. 'scores' => $aScores,
  723. 'reports' => $aReports,
  724. 'comments' => $aComments,
  725. 'title' => $sTitle, //may be empty.
  726. 'description' => '' //may be empty.
  727. );
  728. }
  729. /**
  730. * Check particular action permission without content
  731. * @param $sAction action to check, for example: Browse, Add
  732. * @param $iContentId content ID
  733. * @return message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed
  734. */
  735. public function serviceCheckAllowed($sAction, $isPerformAction = false)
  736. {
  737. $sMethod = 'checkAllowed' . bx_gen_method_name($sAction);
  738. if (!method_exists($this, $sMethod))
  739. return _t('_sys_request_method_not_found_cpt');
  740. return $this->$sMethod($isPerformAction);
  741. }
  742. /**
  743. * Check particular action permission with content
  744. * @param $sAction action to check, for example: View, Edit
  745. * @param $iContentId content ID
  746. * @return message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed
  747. */
  748. public function serviceCheckAllowedWithContent($sAction, $iContentId, $isPerformAction = false)
  749. {
  750. if (!$iContentId || !($aContentInfo = $this->_oDb->getContentInfoById($iContentId)))
  751. return _t('_sys_request_page_not_found_cpt');
  752. $sMethod = 'checkAllowed' . bx_gen_method_name($sAction);
  753. if (!method_exists($this, $sMethod))
  754. return _t('_sys_request_method_not_found_cpt');
  755. return $this->$sMethod($aContentInfo, $isPerformAction);
  756. }
  757. public function serviceCheckAllowedCommentsView($iContentId, $sObjectComments)
  758. {
  759. return $this->serviceCheckAllowedWithContent('comments_view', $iContentId);
  760. }
  761. public function serviceCheckAllowedCommentsPost($iContentId, $sObjectComments)
  762. {
  763. return $this->serviceCheckAllowedWithContent('comments_post', $iContentId);
  764. }
  765. public function serviceGetContentOwnerProfileId ($iContentId)
  766. {
  767. $CNF = &$this->_oConfig->CNF;
  768. // file owner must be author of the content or profile itself in case of profile based module
  769. if ($iContentId) {
  770. if ($this instanceof iBxDolProfileService) {
  771. $oProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName());
  772. }
  773. else {
  774. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  775. $oProfile = $aContentInfo ? BxDolProfile::getInstance($aContentInfo[$CNF['FIELD_AUTHOR']]) : null;
  776. }
  777. $iProfileId = $oProfile ? $oProfile->id() : bx_get_logged_profile_id();
  778. }
  779. else {
  780. $iProfileId = bx_get_logged_profile_id();
  781. }
  782. return $iProfileId;
  783. }
  784. // ====== PERMISSION METHODS
  785. public function checkAllowedSetThumb ($iContentId = 0)
  786. {
  787. return CHECK_ACTION_RESULT_ALLOWED;
  788. }
  789. /**
  790. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking.
  791. */
  792. public function checkAllowedBrowse ()
  793. {
  794. return CHECK_ACTION_RESULT_ALLOWED;
  795. }
  796. /**
  797. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  798. */
  799. public function checkAllowedView ($aDataEntry, $isPerformAction = false)
  800. {
  801. return $this->serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction);
  802. }
  803. public function serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction = false, $iProfileId = false)
  804. {
  805. if (!$iProfileId)
  806. $iProfileId = $this->_iProfileId;
  807. $CNF = &$this->_oConfig->CNF;
  808. // moderator and owner always have access
  809. if (!empty($iProfileId) && ((int)$aDataEntry[$CNF['FIELD_AUTHOR']] == (int)$iProfileId || $this->_isModerator($isPerformAction)))
  810. return CHECK_ACTION_RESULT_ALLOWED;
  811. // check ACL
  812. $aCheck = checkActionModule($iProfileId, 'view entry', $this->getName(), $isPerformAction);
  813. if ($aCheck[CHECK_ACTION_RESULT] !== CHECK_ACTION_RESULT_ALLOWED)
  814. return $aCheck[CHECK_ACTION_MESSAGE];
  815. // check privacy
  816. if (!empty($CNF['OBJECT_PRIVACY_VIEW'])) {
  817. $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_VIEW']);
  818. if ($oPrivacy && !$oPrivacy->check($aDataEntry[$CNF['FIELD_ID']], $iProfileId))
  819. return _t('_sys_access_denied_to_private_content');
  820. }
  821. return CHECK_ACTION_RESULT_ALLOWED;
  822. }
  823. /**
  824. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  825. */
  826. public function checkAllowedAdd ($isPerformAction = false)
  827. {
  828. // check ACL
  829. $aCheck = checkActionModule($this->_iProfileId, 'create entry', $this->getName(), $isPerformAction);
  830. if ($aCheck[CHECK_ACTION_RESULT] !== CHECK_ACTION_RESULT_ALLOWED)
  831. return $aCheck[CHECK_ACTION_MESSAGE];
  832. return CHECK_ACTION_RESULT_ALLOWED;
  833. }
  834. /**
  835. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  836. */
  837. public function checkAllowedEdit ($aDataEntry, $isPerformAction = false)
  838. {
  839. // moderator and owner always have access
  840. if ($aDataEntry[$this->_oConfig->CNF['FIELD_AUTHOR']] == $this->_iProfileId || -$aDataEntry[$this->_oConfig->CNF['FIELD_AUTHOR']] == $this->_iProfileId || $this->_isModerator($isPerformAction))
  841. return CHECK_ACTION_RESULT_ALLOWED;
  842. return _t('_sys_txt_access_denied');
  843. }
  844. /**
  845. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  846. */
  847. public function checkAllowedDelete (&$aDataEntry, $isPerformAction = false)
  848. {
  849. // moderator always has access
  850. if ($this->_isModerator($isPerformAction))
  851. return CHECK_ACTION_RESULT_ALLOWED;
  852. // check ACL
  853. $aCheck = checkActionModule($this->_iProfileId, 'delete entry', $this->getName(), $isPerformAction);
  854. if (($aDataEntry[$this->_oConfig->CNF['FIELD_AUTHOR']] == $this->_iProfileId || -$aDataEntry[$this->_oConfig->CNF['FIELD_AUTHOR']] == $this->_iProfileId) && $aCheck[CHECK_ACTION_RESULT] === CHECK_ACTION_RESULT_ALLOWED)
  855. return CHECK_ACTION_RESULT_ALLOWED;
  856. return _t('_sys_txt_access_denied');
  857. }
  858. /**
  859. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  860. */
  861. public function checkAllowedSetMembership (&$aDataEntry, $isPerformAction = false)
  862. {
  863. // admin always has access
  864. if (isAdmin())
  865. return CHECK_ACTION_RESULT_ALLOWED;
  866. // check ACL
  867. $aCheck = checkActionModule($this->_iProfileId, 'set acl level', 'system', $isPerformAction);
  868. if ($aCheck[CHECK_ACTION_RESULT] !== CHECK_ACTION_RESULT_ALLOWED)
  869. return $aCheck[CHECK_ACTION_MESSAGE];
  870. return CHECK_ACTION_RESULT_ALLOWED;
  871. }
  872. /**
  873. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  874. */
  875. public function checkAllowedEditAnyEntry ($isPerformAction = false)
  876. {
  877. $aCheck = checkActionModule($this->_iProfileId, 'edit any entry', $this->getName(), $isPerformAction);
  878. if($aCheck[CHECK_ACTION_RESULT] === CHECK_ACTION_RESULT_ALLOWED)
  879. return CHECK_ACTION_RESULT_ALLOWED;
  880. return _t('_sys_txt_access_denied');
  881. }
  882. /**
  883. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking.
  884. */
  885. public function checkAllowedCommentsView ($aContentInfo, $isPerformAction = false)
  886. {
  887. return $this->checkAllowedView ($aContentInfo, $isPerformAction);
  888. }
  889. /**
  890. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking.
  891. */
  892. public function checkAllowedCommentsPost ($aContentInfo, $isPerformAction = false)
  893. {
  894. return $this->checkAllowedView ($aContentInfo, $isPerformAction);
  895. }
  896. public function _serviceBrowse ($sMode, $aParams = false, $iDesignBox = BX_DB_PADDING_DEF, $bDisplayEmptyMsg = false, $bAjaxPaginate = true, $sClassSearchResult = 'SearchResult')
  897. {
  898. if (CHECK_ACTION_RESULT_ALLOWED !== ($sMsg = $this->checkAllowedBrowse()))
  899. return MsgBox($sMsg);
  900. bx_import($sClassSearchResult, $this->_aModule);
  901. $sClass = $this->_aModule['class_prefix'] . $sClassSearchResult;
  902. $o = new $sClass($sMode, $aParams);
  903. $o->setDesignBoxTemplateId($iDesignBox);
  904. $o->setDisplayEmptyMsg($bDisplayEmptyMsg);
  905. $o->setAjaxPaginate($bAjaxPaginate);
  906. $o->setUnitParams(array('context' => $sMode));
  907. if ($o->isError)
  908. return '';
  909. if ($s = $o->processing())
  910. return $s;
  911. else
  912. return '';
  913. }
  914. // ====== COMMON METHODS
  915. public function getEntryImageData($aContentInfo, $sField = 'FIELD_THUMB', $aTranscoders = array())
  916. {
  917. if(empty($aTranscoders))
  918. $aTranscoders = array('OBJECT_TRANSCODER_COVER', 'OBJECT_IMAGES_TRANSCODER_COVER', 'OBJECT_IMAGES_TRANSCODER_GALLERY');
  919. $CNF = &$this->_oConfig->CNF;
  920. if(empty($CNF[$sField]) || empty($aContentInfo[$CNF[$sField]]) || empty($CNF['OBJECT_STORAGE']))
  921. return false;
  922. $iId = (int)$aContentInfo[$CNF[$sField]];
  923. foreach($aTranscoders as $sTranscoder)
  924. if(!empty($CNF[$sTranscoder]))
  925. return array('id' => $iId, 'transcoder' => $CNF[$sTranscoder]);
  926. return array('id' => $iId, 'object' => $CNF['OBJECT_STORAGE']);
  927. }
  928. public function getProfileId()
  929. {
  930. return bx_get_logged_profile_id();
  931. }
  932. public function getProfileInfo($iUserId = 0)
  933. {
  934. $oProfile = $this->getObjectUser($iUserId);
  935. $oAccount = null;
  936. if($oProfile && !($oProfile instanceof BxDolProfileUndefined) && !($oProfile instanceof BxDolProfileAnonymous))
  937. $oAccount = $oProfile->getAccountObject();
  938. $bAccount = !empty($oAccount);
  939. return array(
  940. 'id' => $oProfile->id(),
  941. 'name' => $oProfile->getDisplayName(),
  942. 'email' => $bAccount ? $oAccount->getEmail() : '',
  943. 'link' => $oProfile->getUrl(),
  944. 'icon' => $oProfile->getIcon(),
  945. 'thumb' => $oProfile->getThumb(),
  946. 'avatar' => $oProfile->getAvatar(),
  947. 'unit' => $oProfile->getUnit(),
  948. 'active' => $oProfile->isActive(),
  949. );
  950. }
  951. public function getObjectUser($iUserId = 0)
  952. {
  953. bx_import('BxDolProfile');
  954. $oProfile = BxDolProfile::getInstanceMagic($iUserId);
  955. return $oProfile;
  956. }
  957. public function getObjectFavorite($sSystem = '', $iId = 0)
  958. {
  959. $CNF = &$this->_oConfig->CNF;
  960. if(empty($sSystem) && !empty($CNF['OBJECT_FAVORITES']))
  961. $sSystem = $CNF['OBJECT_FAVORITES'];
  962. if(empty($sSystem))
  963. return false;
  964. $oFavorite = BxDolFavorite::getObjectInstance($sSystem, $iId, true, $this->_oTemplate);
  965. if(!$oFavorite->isEnabled())
  966. return false;
  967. return $oFavorite;
  968. }
  969. public function getUserId()
  970. {
  971. return isLogged() ? bx_get_logged_profile_id() : 0;
  972. }
  973. public function getUserIp()
  974. {
  975. return getVisitorIP();
  976. }
  977. public function getUserInfo($iUserId = 0)
  978. {
  979. $oProfile = BxDolProfile::getInstanceMagic($iUserId);
  980. return array(
  981. $oProfile->getDisplayName(),
  982. $oProfile->getUrl(),
  983. $oProfile->getThumb(),
  984. $oProfile->getUnit(),
  985. $oProfile->getUnit(0, array('template' => 'unit_wo_info'))
  986. );
  987. }
  988. public function _isModerator ($isPerformAction = false)
  989. {
  990. return CHECK_ACTION_RESULT_ALLOWED === $this->checkAllowedEditAnyEntry ($isPerformAction);
  991. }
  992. // ====== PROTECTED METHODS
  993. protected function _serviceEntityForm ($sFormMethod, $iContentId = 0, $sDisplay = false, $sCheckFunction = false, $bErrorMsg = true)
  994. {
  995. $iContentId = $this->_getContent($iContentId, false);
  996. if($iContentId === false)
  997. return false;
  998. bx_import('FormsEntryHelper', $this->_aModule);
  999. $sClass = $this->_aModule['class_prefix'] . 'FormsEntryHelper';
  1000. $oFormsHelper = new $sClass($this);
  1001. return $oFormsHelper->$sFormMethod((int)$iContentId, $sDisplay, $sCheckFunction, $bErrorMsg);
  1002. }
  1003. protected function _serviceTemplateFunc ($sFunc, $iContentId, $sFuncGetContent = 'getContentInfoById')
  1004. {
  1005. $mixedContent = $this->_getContent($iContentId, $sFuncGetContent);
  1006. if($mixedContent === false)
  1007. return false;
  1008. list($iContentId, $aContentInfo) = $mixedContent;
  1009. return $this->_oTemplate->$sFunc($aContentInfo);
  1010. }
  1011. protected function _rss ($aArgs, $sClass = 'SearchResult')
  1012. {
  1013. $sMode = array_shift($aArgs);
  1014. if (CHECK_ACTION_RESULT_ALLOWED !== ($sMsg = $this->checkAllowedBrowse())) {
  1015. $this->_oTemplate->displayAccessDenied ($sMsg);
  1016. exit;
  1017. }
  1018. $aParams = $this->_buildRssParams($sMode, $aArgs);
  1019. bx_import ($sClass, $this->_aModule);
  1020. $sClass = $this->_aModule['class_prefix'] . $sClass;
  1021. $o = new $sClass($sMode, $aParams);
  1022. if ($o->isError)
  1023. $this->_oTemplate->displayPageNotFound ();
  1024. else
  1025. $o->outputRSS();
  1026. exit;
  1027. }
  1028. protected function _getContent($iContentId = 0, $sFuncGetContent = 'getContentInfoById')
  1029. {
  1030. if(!$iContentId)
  1031. $iContentId = bx_process_input(bx_get('id'), BX_DATA_INT);
  1032. if(!$iContentId)
  1033. return false;
  1034. if(empty($sFuncGetContent) || !method_exists($this->_oDb, $sFuncGetContent))
  1035. return $iContentId;
  1036. $aContentInfo = $this->_oDb->$sFuncGetContent($iContentId);
  1037. if(!$aContentInfo)
  1038. return false;
  1039. return array($iContentId, $aContentInfo);
  1040. }
  1041. protected function _getContentForTimelinePost($aEvent, $aContentInfo, $aBrowseParams = array())
  1042. {
  1043. $CNF = &$this->_oConfig->CNF;
  1044. $sUrl = BX_DOL_URL_ROOT . BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]);
  1045. //--- Image(s)
  1046. $aImages = $this->_getImagesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams);
  1047. //--- Video(s)
  1048. $aVideos = $this->_getVideosForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams);
  1049. //--- Text
  1050. $sText = isset($CNF['FIELD_TEXT']) && isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : '';
  1051. if(!empty($CNF['OBJECT_METATAGS']) && is_string($sText)) {
  1052. $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']);
  1053. $sText = $oMetatags->metaParse($aContentInfo[$CNF['FIELD_ID']], $sText);
  1054. }
  1055. return array(
  1056. 'sample' => isset($CNF['T']['txt_sample_single_with_article']) ? $CNF['T']['txt_sample_single_with_article'] : $CNF['T']['txt_sample_single'],
  1057. 'sample_wo_article' => $CNF['T']['txt_sample_single'],
  1058. 'sample_action' => isset($CNF['T']['txt_sample_action']) ? $CNF['T']['txt_sample_action'] : '',
  1059. 'url' => $sUrl,
  1060. 'title' => isset($CNF['FIELD_TITLE']) && isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] :
  1061. (isset($CNF['FIELD_TEXT']) && isset($aContentInfo[$CNF['FIELD_TEXT']]) ? strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...') : ''),
  1062. 'text' => $sText,
  1063. 'images' => $aImages,
  1064. 'videos' => $aVideos
  1065. );
  1066. }
  1067. protected function _getImagesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array())
  1068. {
  1069. $CNF = &$this->_oConfig->CNF;
  1070. $sImage = $sImageOrig = '';
  1071. if(isset($CNF['FIELD_COVER']) && isset($aContentInfo[$CNF['FIELD_COVER']]) && $aContentInfo[$CNF['FIELD_COVER']]) {
  1072. $sImage = $this->_oConfig->getImageUrl($aContentInfo[$CNF['FIELD_COVER']], array('OBJECT_IMAGES_TRANSCODER_GALLERY', 'OBJECT_IMAGES_TRANSCODER_THUMB'));
  1073. $sImageOrig = $this->_oConfig->getImageUrl($aContentInfo[$CNF['FIELD_COVER']], array('OBJECT_IMAGES_TRANSCODER_COVER'));
  1074. }
  1075. $bImageThumb = isset($CNF['FIELD_THUMB']) && isset($aContentInfo[$CNF['FIELD_THUMB']]) && $aContentInfo[$CNF['FIELD_THUMB']];
  1076. if($sImage == '' && $bImageThumb)
  1077. $sImage = $this->_oConfig->getImageUrl($aContentInfo[$CNF['FIELD_THUMB']], array('OBJECT_IMAGES_TRANSCODER_GALLERY', 'OBJECT_IMAGES_TRANSCODER_THUMB'));
  1078. if($sImageOrig == '' && $bImageThumb)
  1079. $sImageOrig = $this->_oConfig->getImageUrl($aContentInfo[$CNF['FIELD_THUMB']], array('OBJECT_IMAGES_TRANSCODER_COVER'));
  1080. if(empty($sImage))
  1081. return array();
  1082. if($sImageOrig == '')
  1083. $sImageOrig = $sImage;
  1084. return array(
  1085. array('url' => $sUrl, 'src' => $sImage, 'src_orig' => $sImageOrig),
  1086. );
  1087. }
  1088. protected function _getVideosForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array())
  1089. {
  1090. return array();
  1091. }
  1092. protected function _entityComments ($sObject, $iId = 0)
  1093. {
  1094. if (!$iId)
  1095. $iId = bx_process_input(bx_get('id'), BX_DATA_INT);
  1096. if (!$iId)
  1097. return false;
  1098. $oCmts = BxDolCmts::getObjectInstance($sObject, $iId);
  1099. if (!$oCmts || !$oCmts->isEnabled())
  1100. return false;
  1101. return $oCmts->getCommentsBlock(array(), array('in_designbox' => false, 'show_empty' => true));
  1102. }
  1103. protected function _entitySocialSharing ($iId, $aParams = array())
  1104. {
  1105. $bShowAsButton = !isset($aParams['show_as_button']) || $aParams['show_as_button'] === true;
  1106. $sUrl = !empty($aParams['uri_view_entry']) ? BxDolPermalinks::getInstance()->permalink('page.php?i=' . $aParams['uri_view_entry'] . '&id=' . $iId) : '';
  1107. $sTitle = !empty($aParams['title']) ? $aParams['title'] : '';
  1108. //--- Comments
  1109. $sComments = '';
  1110. $oComments = !empty($aParams['object_comments']) ? BxTemplCmts::getObjectInstance($aParams['object_comments'], $iId) : false;
  1111. if ($oComments) {
  1112. $iNum = $oComments->getCommentsCountAll();
  1113. $sComments = $this->_oTemplate->parseHtmlByName('comments-item.html', array (
  1114. 'class' => 'bx-base-general-comments-' . ($bShowAsButton ? 'button' : 'link'),
  1115. 'class_do' => $bShowAsButton ? ' bx-btn' : '',
  1116. 'class_counter' => $bShowAsButton ? ' bx-btn-height' : '',
  1117. 'url' => $sUrl . $oComments->getListAnchor(true),
  1118. 'bx_if:comments' => array (
  1119. 'condition' => $iNum,
  1120. 'content' => array (
  1121. 'num' => $iNum,
  1122. ),
  1123. ),
  1124. ));
  1125. }
  1126. $aCustomParams = array();
  1127. $iIdThumb = isset($aParams['id_thumb']) ? (int)$aParams['id_thumb'] : 0;
  1128. $bSocialSharing = isset($aParams['social_sharing']) ? (bool)$aParams['social_sharing'] : true;
  1129. if ($iIdThumb && $bSocialSharing) {
  1130. if(!empty($aParams['object_transcoder']))
  1131. $o = BxDolTranscoder::getObjectInstance($aParams['object_transcoder']);
  1132. else if(!empty($aParams['object_storage']))
  1133. $o = BxDolStorage::getObjectInstance($aParams['object_storage']);
  1134. $sImgUrl = $o ? $o->getFileUrlById($iIdThumb) : '';
  1135. if($sImgUrl)
  1136. $aCustomParams = array (
  1137. 'img_url' => $sImgUrl,
  1138. 'img_url_encoded' => rawurlencode($sImgUrl),
  1139. );
  1140. }
  1141. //TODO: Rebuild using menus engine when it will be ready for such elements like Vote, Share, etc.
  1142. //--- Views
  1143. $sViews = '';
  1144. $oViews = !empty($aParams['object_view']) ? BxDolView::getObjectInstance($aParams['object_view'], $iId) : false;
  1145. if ($oViews && $oViews->isEnabled())
  1146. $sViews = $oViews->getElementBlock(array('show_do_view_as_button' => $bShowAsButton));
  1147. //--- Votes
  1148. $sVotes = '';
  1149. $oVotes = !empty($aParams['object_vote']) ? BxDolVote::getObjectInstance($aParams['object_vote'], $iId) : false;
  1150. if ($oVotes && $oVotes->isEnabled())
  1151. $sVotes = $oVotes->getElementBlock(array('show_do_vote_as_button' => $bShowAsButton));
  1152. //--- Scores
  1153. $sScores = '';
  1154. $oScores = !empty($aParams['object_score']) ? BxDolScore::getObjectInstance($aParams['object_score'], $iId) : false;
  1155. if ($oScores && $oScores->isEnabled())
  1156. $sScores = $oScores->getElementBlock(array('show_do_vote_as_button' => $bShowAsButton));
  1157. //--- Favorite
  1158. $sFavorites = '';
  1159. $oFavorites = !empty($aParams['object_favorite']) ? BxDolFavorite::getObjectInstance($aParams['object_favorite'], $iId) : false;
  1160. if ($oFavorites && $oFavorites->isEnabled())
  1161. $sFavorites = $oFavorites->getElementBlock(array('show_do_favorite_as_button' => $bShowAsButton));
  1162. //--- Featured
  1163. $sFeatured = '';
  1164. $oFeatured = !empty($aParams['object_feature']) ? BxDolFeature::getObjectInstance($aParams['object_feature'], $iId) : false;
  1165. if ($oFeatured && $oFeatured->isEnabled())
  1166. $sFeatured = $oFeatured->getElementBlock(array('show_do_feature_as_button' => $bShowAsButton));
  1167. //--- Timeline Repost
  1168. $sRepost = '';
  1169. $iIdTimeline = isset($aParams['id_timeline']) ? (int)$aParams['id_timeline'] : $iId;
  1170. if ($iIdTimeline && BxDolRequest::serviceExists('bx_timeline', 'get_repost_element_block'))
  1171. $sRepost = BxDolService::call('bx_timeline', 'get_repost_element_block', array(bx_get_logged_profile_id(), $this->_aModule['name'], 'added', $iIdTimeline, array('show_do_repost_as_button' => $bShowAsButton)));
  1172. //--- Report
  1173. $sReport = '';
  1174. $oReport = !empty($aParams['object_report']) ? BxDolReport::getObjectInstance($aParams['object_report'], $iId) : false;
  1175. if ($oReport)
  1176. $sReport = $oReport->getElementBlock(array('show_do_report_as_button' => $bShowAsButton));
  1177. $sSocial = '';
  1178. if($bSocialSharing) {
  1179. $oSocial = BxDolMenu::getObjectInstance('sys_social_sharing');
  1180. $oSocial->addMarkers(array_merge(array(
  1181. 'id' => $iId,
  1182. 'module' => $this->_aModule['name'],
  1183. 'url' => BX_DOL_URL_ROOT . $sUrl,
  1184. 'title' => $sTitle,
  1185. ), $aCustomParams));
  1186. $sSocial = $oSocial->getCode();
  1187. }
  1188. if(empty($sComments) && empty($sViews) && empty($sVotes) && empty($sScores) && empty($sFavorites) && empty($sFeatured) && empty($sRepost) && empty($sReport) && empty($sSocial))
  1189. return '';
  1190. return $this->_oTemplate->parseHtmlByName('entry-share.html', array(
  1191. 'comments' => $sComments,
  1192. 'view' => $sViews,
  1193. 'vote' => $sVotes,
  1194. 'score' => $sScores,
  1195. 'favorite' => $sFavorites,
  1196. 'feature' => $sFeatured,
  1197. 'repost' => $sRepost,
  1198. 'report' => $sReport,
  1199. 'social' => $sSocial,
  1200. ));
  1201. //TODO: Rebuild using menus engine when it will be ready for such elements like Vote, Repost, etc.
  1202. }
  1203. protected function _getFields($iContentId)
  1204. {
  1205. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  1206. if(empty($aContentInfo))
  1207. return array();
  1208. return BxDolContentInfo::formatFields($aContentInfo);
  1209. }
  1210. protected function _getFieldValue($sField, $iContentId)
  1211. {
  1212. $CNF = &$this->_oConfig->CNF;
  1213. if(empty($CNF[$sField]))
  1214. return false;
  1215. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  1216. if(empty($aContentInfo) || empty($aContentInfo[$CNF[$sField]]))
  1217. return false;
  1218. return $aContentInfo[$CNF[$sField]];
  1219. }
  1220. protected function _getFieldValueThumb($sField, $iContentId, $sTranscoder = '')
  1221. {
  1222. $CNF = &$this->_oConfig->CNF;
  1223. if(empty($sTranscoder) || empty($CNF[$sField]))
  1224. return false;
  1225. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  1226. if(empty($aContentInfo) || empty($aContentInfo[$CNF[$sField]]))
  1227. return false;
  1228. $oImagesTranscoder = BxDolTranscoderImage::getObjectInstance($sTranscoder);
  1229. if(!$oImagesTranscoder)
  1230. return false;
  1231. return $oImagesTranscoder->getFileUrl($aContentInfo[$CNF[$sField]]);
  1232. }
  1233. protected function _prepareResponse($aResponse, $bAsJson = false, $aAdditional = array())
  1234. {
  1235. if(!$bAsJson)
  1236. return $aResponse;
  1237. if(!empty($aAdditional) && is_array($aAdditional))
  1238. $aResponse = array_merge($aResponse, $aAdditional);
  1239. echoJson($aResponse);
  1240. exit;
  1241. }
  1242. }
  1243. /** @} */