BxAlbumsConfig.php 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
  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 Albums Albums
  7. * @ingroup UnaModules
  8. *
  9. * @{
  10. */
  11. class BxAlbumsConfig extends BxBaseModTextConfig
  12. {
  13. function __construct($aModule)
  14. {
  15. parent::__construct($aModule);
  16. $aMenuItems2Methods = array (
  17. 'approve' => 'checkAllowedApprove',
  18. 'add-images-to-album' => 'checkAllowedEdit',
  19. 'edit-album' => 'checkAllowedEdit',
  20. 'edit-image' => 'checkAllowedEdit',
  21. 'move-image' => 'checkAllowedEdit',
  22. 'delete-album' => 'checkAllowedDelete',
  23. 'delete-image' => 'checkAllowedDelete',
  24. );
  25. $this->CNF = array (
  26. // module icon
  27. 'ICON' => 'far image',
  28. // database tables
  29. 'TABLE_ENTRIES' => $aModule['db_prefix'] . 'albums',
  30. 'TABLE_ENTRIES_FULLTEXT' => 'title_text',
  31. 'TABLE_FILES2ENTRIES' => $aModule['db_prefix'] . 'files2albums',
  32. 'TABLE_FILES' => $aModule['db_prefix'] . 'files',
  33. // database fields
  34. 'FIELD_ID' => 'id',
  35. 'FIELD_AUTHOR' => 'author',
  36. 'FIELD_ADDED' => 'added',
  37. 'FIELD_CHANGED' => 'changed',
  38. 'FIELD_TITLE' => 'title',
  39. 'FIELD_TEXT' => 'text',
  40. 'FIELD_TEXT_ID' => 'album-desc',
  41. 'FIELD_ALLOW_VIEW_TO' => 'allow_view_to',
  42. 'FIELD_CF' => 'cf',
  43. 'FIELD_PHOTO' => 'pictures',
  44. 'FIELD_THUMB' => 'thumb',
  45. 'FIELD_VIEWS' => 'views',
  46. 'FIELD_COMMENTS' => 'comments',
  47. 'FIELD_STATUS' => 'status',
  48. 'FIELD_STATUS_ADMIN' => 'status_admin',
  49. 'FIELD_LOCATION' => 'location',
  50. 'FIELD_LOCATION_PREFIX' => 'location',
  51. 'FIELD_LABELS' => 'labels',
  52. 'FIELDS_WITH_KEYWORDS' => 'auto', // can be 'auto', array of fields or comma separated string of field names, works only when OBJECT_METATAGS is specified
  53. 'FIELDS_DELAYED_PROCESSING' => 'pictures', // can be array of fields or comma separated string of field names
  54. // page URIs
  55. 'URI_VIEW_ENTRY' => 'view-album',
  56. 'URI_VIEW_MEDIA' => 'view-album-media',
  57. 'URI_AUTHOR_ENTRIES' => 'albums-author',
  58. 'URI_ENTRIES_BY_CONTEXT' => 'albums-context',
  59. 'URI_ADD_ENTRY' => 'create-album',
  60. 'URI_EDIT_ENTRY' => 'edit-album',
  61. 'URI_MANAGE_COMMON' => 'albums-manage',
  62. 'URI_FAVORITES_LIST' => 'albums-favorites',
  63. 'URI_EDIT_MEDIA' => 'edit-media',
  64. 'URI_MOVE_MEDIA' => 'move-media',
  65. 'URI_DELETE_MEDIA' => 'delete-media',
  66. 'URL_HOME' => 'page.php?i=albums-home',
  67. 'URL_POPULAR' => 'page.php?i=albums-popular',
  68. 'URL_TOP' => 'page.php?i=albums-top',
  69. 'URL_UPDATED' => 'page.php?i=albums-home',
  70. 'URL_POPULAR_MEDIA' => 'page.php?i=albums-popular-media',
  71. 'URL_TOP_MEDIA' => 'page.php?i=albums-top-media',
  72. 'URL_RECENT_MEDIA' => 'page.php?i=albums-recent-media', // TODO: add page
  73. 'URL_MANAGE_COMMON' => 'page.php?i=albums-manage',
  74. 'URL_MANAGE_ADMINISTRATION' => 'page.php?i=albums-administration',
  75. // some params
  76. 'PARAM_AUTO_APPROVE' => 'bx_albums_enable_auto_approve',
  77. 'PARAM_CHARS_SUMMARY' => 'bx_albums_summary_chars',
  78. 'PARAM_CHARS_SUMMARY_PLAIN' => 'bx_albums_plain_summary_chars',
  79. 'PARAM_NUM_RSS' => 'bx_albums_rss_num',
  80. 'PARAM_SEARCHABLE_FIELDS' => 'bx_albums_searchable_fields',
  81. 'PARAM_PER_PAGE_FOR_FAVORITES_LISTS' => 'bx_albums_per_page_for_favorites_lists',
  82. 'PARAM_ORDER_BY_GHOSTS' => true,
  83. // objects
  84. 'OBJECT_STORAGE' => 'bx_albums_files',
  85. 'OBJECT_IMAGES_TRANSCODER_PREVIEW' => 'bx_albums_proxy_preview',
  86. 'OBJECT_IMAGES_TRANSCODER_GALLERY' => '',
  87. 'OBJECT_IMAGES_TRANSCODER_BIG' => 'bx_albums_big',
  88. 'OBJECT_VIDEOS_TRANSCODERS' => array(
  89. 'poster' => 'bx_albums_video_poster_big',
  90. 'poster_preview' => 'bx_albums_video_poster_preview',
  91. 'mp4' => 'bx_albums_video_mp4',
  92. 'mp4_hd' => 'bx_albums_video_mp4_hd'
  93. ),
  94. 'OBJECT_VIDEO_TRANSCODER_HEIGHT' => '480px',
  95. 'OBJECT_TRANSCODER_BROWSE' => 'bx_albums_proxy_browse',
  96. 'OBJECT_TRANSCODER_COVER' => 'bx_albums_proxy_cover',
  97. 'OBJECT_REPORTS' => 'bx_albums',
  98. 'OBJECT_REPORTS_MEDIA' => 'bx_albums_media',
  99. 'OBJECT_VIEWS' => 'bx_albums',
  100. 'OBJECT_VIEWS_MEDIA' => 'bx_albums_media',
  101. 'OBJECT_VOTES' => 'bx_albums',
  102. 'OBJECT_VOTES_MEDIA' => 'bx_albums_media',
  103. 'OBJECT_REACTIONS' => 'bx_albums_reactions',
  104. 'OBJECT_SCORES' => 'bx_albums',
  105. 'OBJECT_SCORES_MEDIA' => 'bx_albums_media',
  106. 'OBJECT_FAVORITES' => 'bx_albums',
  107. 'OBJECT_FAVORITES_MEDIA' => 'bx_albums_media',
  108. 'OBJECT_FEATURED' => 'bx_albums',
  109. 'OBJECT_FEATURED_MEDIA' => 'bx_albums_media',
  110. 'OBJECT_METATAGS' => 'bx_albums',
  111. 'OBJECT_METATAGS_MEDIA' => 'bx_albums_media',
  112. 'OBJECT_METATAGS_MEDIA_CAMERA' => 'bx_albums_media_camera',
  113. 'OBJECT_COMMENTS' => 'bx_albums',
  114. 'OBJECT_NOTES' => 'bx_albums_notes',
  115. 'OBJECT_COMMENTS_MEDIA' => 'bx_albums_media',
  116. 'OBJECT_PRIVACY_VIEW' => 'bx_albums_allow_view_to',
  117. 'OBJECT_PRIVACY_LIST_VIEW' => 'bx_albums_allow_view_favorite_list',
  118. 'OBJECT_FORM_ENTRY' => 'bx_albums',
  119. 'OBJECT_FORM_ENTRY_DISPLAY_VIEW' => 'bx_albums_entry_view',
  120. 'OBJECT_FORM_ENTRY_DISPLAY_ADD' => 'bx_albums_entry_add',
  121. 'OBJECT_FORM_ENTRY_DISPLAY_EDIT' => 'bx_albums_entry_edit',
  122. 'OBJECT_FORM_ENTRY_DISPLAY_DELETE' => 'bx_albums_entry_delete',
  123. 'OBJECT_FORM_MEDIA' => 'bx_albums_media',
  124. 'OBJECT_FORM_MEDIA_DISPLAY_EDIT' => 'bx_albums_media_edit',
  125. 'OBJECT_FORM_MEDIA_DISPLAY_MOVE' => 'bx_albums_media_move',
  126. 'OBJECT_FORM_MEDIA_DISPLAY_DELETE' => 'bx_albums_media_delete',
  127. 'OBJECT_MENU_ACTIONS_VIEW_ENTRY' => 'bx_albums_view', // actions menu on view entry page
  128. 'OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL' => 'bx_albums_view_actions', // all actions menu on view entry page
  129. 'OBJECT_MENU_ACTIONS_VIEW_MEDIA' => 'bx_albums_view_media', // actions menu on view media page
  130. 'OBJECT_MENU_ACTIONS_VIEW_MEDIA_ALL' => 'bx_albums_view_actions_media', // all actions menu on view media page
  131. 'OBJECT_MENU_ACTIONS_VIEW_MEDIA_UNIT' => 'bx_albums_view_actions_media_unit', // actions menu on media unit
  132. 'OBJECT_MENU_ACTIONS_MY_ENTRIES' => 'bx_albums_my', // actions menu on my entries page
  133. 'OBJECT_MENU_SUBMENU' => 'bx_albums_submenu', // main module submenu
  134. 'OBJECT_MENU_SUBMENU_VIEW_ENTRY' => 'bx_albums_view_submenu', // view entry submenu
  135. 'OBJECT_MENU_SUBMENU_VIEW_ENTRY_MAIN_SELECTION' => 'albums-home', // first item in view entry submenu from main module submenu
  136. 'OBJECT_MENU_SNIPPET_META' => 'bx_albums_snippet_meta', // menu for snippet meta info
  137. 'OBJECT_MENU_MANAGE_TOOLS' => 'bx_albums_menu_manage_tools', //manage menu in content administration tools
  138. 'OBJECT_GRID_ADMINISTRATION' => 'bx_albums_administration',
  139. 'OBJECT_GRID_COMMON' => 'bx_albums_common',
  140. 'OBJECT_UPLOADERS' => array('bx_albums_html5', 'bx_albums_crop'),
  141. 'FUNCTION_FOR_GET_ITEM_INFO' => 'getMediaInfoById',
  142. 'BADGES_AVALIABLE' => true,
  143. // menu items which visibility depends on custom visibility checking
  144. 'MENU_ITEM_TO_METHOD' => array (
  145. 'bx_albums_my' => array (
  146. 'create-album' => 'checkAllowedAdd',
  147. ),
  148. 'bx_albums_view' => $aMenuItems2Methods,
  149. 'bx_albums_view_media' => $aMenuItems2Methods,
  150. ),
  151. // informer messages
  152. 'INFORMERS' => array (
  153. 'approving' => array (
  154. 'name' => 'bx-albums-approving',
  155. 'map' => array (
  156. 'pending' => array('msg' => '_bx_albums_txt_msg_status_pending', 'type' => BX_INFORMER_ALERT),
  157. 'hidden' => array('msg' => '_bx_albums_txt_msg_status_hidden', 'type' => BX_INFORMER_ERROR),
  158. ),
  159. ),
  160. 'processing' => array (
  161. 'name' => 'bx_albums-processing',
  162. 'map' => array (
  163. 'awaiting' => array('msg' => '_bx_albums_txt_processing_awaiting', 'type' => BX_INFORMER_ALERT),
  164. 'failed' => array('msg' => '_bx_albums_txt_processing_failed', 'type' => BX_INFORMER_ERROR)
  165. ),
  166. ),
  167. ),
  168. // some language keys
  169. 'T' => array (
  170. 'txt_sample_single' => '_bx_albums_txt_sample_single',
  171. 'txt_sample_single_with_article' => '_bx_albums_txt_sample_single_with_article',
  172. 'txt_sample_comment_single' => '_bx_albums_txt_sample_comment_single',
  173. 'txt_sample_vote_single' => '_bx_albums_txt_sample_vote_single',
  174. 'txt_sample_reaction_single' => '_bx_albums_txt_sample_reaction_single',
  175. 'txt_sample_score_up_single' => '_bx_albums_txt_sample_score_up_single',
  176. 'txt_sample_score_down_single' => '_bx_albums_txt_sample_score_down_single',
  177. 'txt_sample_action_changed' => '_bx_albums_txt_sample_action_changed',
  178. 'txt_media_single' => '_bx_albums_txt_media_single',
  179. 'txt_media_comment_single' => '_bx_albums_txt_media_comment_single',
  180. 'txt_media_vote_single' => '_bx_albums_txt_media_vote_single',
  181. 'txt_media_score_up_single' => '_bx_albums_txt_media_score_up_single',
  182. 'txt_media_score_down_single' => '_bx_albums_txt_media_score_down_single',
  183. 'form_field_author' => '_bx_albums_form_entry_input_author',
  184. 'grid_action_err_delete' => '_bx_albums_grid_action_err_delete',
  185. 'grid_txt_account_manager' => '_bx_albums_grid_txt_account_manager',
  186. 'filter_item_active' => '_bx_albums_grid_filter_item_title_adm_active',
  187. 'filter_item_hidden' => '_bx_albums_grid_filter_item_title_adm_hidden',
  188. 'filter_item_pending' => '_bx_albums_grid_filter_item_title_adm_pending',
  189. 'filter_item_select_one_filter1' => '_bx_albums_grid_filter_item_title_adm_select_one_filter1',
  190. 'filter_item_select_one_filter2' => '_bx_albums_grid_filter_item_title_adm_select_one_filter2',
  191. 'menu_item_manage_my' => '_bx_albums_menu_item_title_manage_my',
  192. 'menu_item_manage_all' => '_bx_albums_menu_item_title_manage_all',
  193. 'txt_all_entries_by' => '_bx_albums_txt_all_entries_by',
  194. 'txt_all_entries_in' => '_bx_albums_txt_all_entries_in',
  195. 'txt_all_entries_by_author' => '_bx_albums_page_title_browse_by_author',
  196. 'txt_all_entries_by_context' => '_bx_albums_page_title_browse_by_context',
  197. 'txt_media_exif_camera' => '_bx_albums_txt_media_album_camera',
  198. 'txt_media_exif_focal_length' => '_bx_albums_txt_media_album_focal_length',
  199. 'txt_media_exif_focal_length_value' => '_bx_albums_txt_media_album_focal_length_value',
  200. 'txt_media_exif_aperture' => '_bx_albums_txt_media_album_aperture',
  201. 'txt_media_exif_shutter_speed' => '_bx_albums_txt_media_album_shutter_speed',
  202. 'txt_media_exif_shutter_speed_value' => '_bx_albums_txt_media_album_shutter_speed_value',
  203. 'txt_media_exif_iso' => '_bx_albums_txt_media_album_iso',
  204. ),
  205. );
  206. $this->_aJsClasses = array(
  207. 'main' => 'BxAlbumsMain',
  208. 'manage_tools' => 'BxAlbumsManageTools'
  209. );
  210. $this->_aJsObjects = array(
  211. 'main' => 'oBxAlbumsMain',
  212. 'manage_tools' => 'oBxAlbumsManageTools'
  213. );
  214. $this->_aGridObjects = array(
  215. 'common' => $this->CNF['OBJECT_GRID_COMMON'],
  216. 'administration' => $this->CNF['OBJECT_GRID_ADMINISTRATION'],
  217. );
  218. }
  219. public function getAlbumUrl($iId)
  220. {
  221. $sUrl = BxDolPermalinks::getInstance()->permalink('page.php?i=' . $this->CNF['URI_VIEW_ENTRY'] . '&id=' . $iId);
  222. return bx_absolute_url($sUrl);
  223. }
  224. public function getMediaUrl($iId, $sContext = '')
  225. {
  226. $sUrl = BxDolPermalinks::getInstance()->permalink('page.php?i=' . $this->CNF['URI_VIEW_MEDIA'] . '&id=' . $iId);
  227. if($sContext)
  228. $sUrl = bx_append_url_params($sUrl, [
  229. 'context' => $sContext
  230. ]);
  231. return bx_absolute_url($sUrl);
  232. }
  233. }
  234. /** @} */