BxBaseModGeneralModule.php 50 KB

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