BxBaseEditorQuill.php 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  1. <?php defined('BX_DOL') or die('hack attempt');
  2. /**
  3. * Copyright (c) UNA, Inc - https://una.io
  4. * MIT License - https://opensource.org/licenses/MIT
  5. *
  6. * @defgroup UnaBaseView UNA Base Representation Classes
  7. * @{
  8. */
  9. /**
  10. * Quill editor representation.
  11. * @see BxDolEditor
  12. */
  13. class BxBaseEditorQuill extends BxDolEditor
  14. {
  15. /**
  16. * Common initialization params
  17. */
  18. protected static $CONF_COMMON = "
  19. var oParams = {
  20. skin: '{bx_var_skin}',
  21. name: '{bx_var_editor_name}',
  22. selector: '{bx_var_selector}',
  23. css_class: '{bx_var_css_additional_class}',
  24. toolbar: {toolbar},
  25. root_url: '{bx_url_root}',
  26. query_params: {bx_var_query_params},
  27. }
  28. {bx_var_editor_name} = bx_editor_init({bx_var_editor_name}, oParams);";
  29. /**
  30. * Standard view initialization params
  31. */
  32. protected static $CONF_STANDARD = "";
  33. /**
  34. * Minimal view initialization params
  35. */
  36. protected static $CONF_MINI = "";
  37. /**
  38. * Full view initialization params
  39. */
  40. protected static $CONF_FULL = "";
  41. protected $_oTemplate;
  42. protected $_bJsCssAdded = false;
  43. public function __construct ($aObject, $oTemplate)
  44. {
  45. parent::__construct ($aObject);
  46. if ($oTemplate)
  47. $this->_oTemplate = $oTemplate;
  48. else
  49. $this->_oTemplate = BxDolTemplate::getInstance();
  50. }
  51. /**
  52. * Attach editor to HTML element, in most cases - textarea.
  53. * @param $sSelector - jQuery selector to attach editor to.
  54. * @param $iViewMode - editor view mode: BX_EDITOR_STANDARD, BX_EDITOR_MINI, BX_EDITOR_FULL
  55. * @param $bDynamicMode - is AJAX mode or not, the HTML with editor area is loaded dynamically.
  56. */
  57. public function attachEditor ($sSelector, $iViewMode = BX_EDITOR_STANDARD, $bDynamicMode = false, $aAttrs = [])
  58. {
  59. // set visual mode
  60. switch ($iViewMode) {
  61. case BX_EDITOR_MINI:
  62. $sToolbarItems = getParam('sys_quill_toolbar_mini');
  63. $sCustomInit = self::$CONF_MINI;
  64. break;
  65. case BX_EDITOR_FULL:
  66. $sToolbarItems = getParam('sys_quill_toolbar_full');
  67. $sCustomInit = self::$CONF_FULL;
  68. break;
  69. case BX_EDITOR_STANDARD:
  70. default:
  71. $sToolbarItems = getParam('sys_quill_toolbar_standard');
  72. $sCustomInit = self::$CONF_STANDARD;
  73. }
  74. if ($this->_sButtonsCustom !== false) {
  75. $sToolbarItems = $this->_sButtonsCustom;
  76. }
  77. $sEditorName = 'quill_' . str_replace(['-', ' '], '_', $aAttrs['form_id'] . '_' . $aAttrs['element_name']);
  78. $this->_oTemplate->addJsTranslation([
  79. '_sys_txt_quill_tooltip_bold',
  80. '_sys_txt_quill_tooltip_italic',
  81. '_sys_txt_quill_tooltip_underline',
  82. '_sys_txt_quill_tooltip_clean',
  83. '_sys_txt_quill_tooltip_list_ordered',
  84. '_sys_txt_quill_tooltip_list_bullet',
  85. '_sys_txt_quill_tooltip_indent_1',
  86. '_sys_txt_quill_tooltip_indent_2',
  87. '_sys_txt_quill_tooltip_blockquote',
  88. '_sys_txt_quill_tooltip_direction',
  89. '_sys_txt_quill_tooltip_script_sub',
  90. '_sys_txt_quill_tooltip_script_super',
  91. '_sys_txt_quill_tooltip_link',
  92. '_sys_txt_quill_tooltip_image',
  93. '_sys_txt_quill_tooltip_code_block',
  94. '_sys_txt_quill_tooltip_color',
  95. '_sys_txt_quill_tooltip_background',
  96. '_sys_txt_quill_tooltip_align',
  97. '_sys_txt_quill_tooltip_header',
  98. '_sys_txt_quill_tooltip_embed',
  99. '_sys_txt_quill_tooltip_embed_popup_header',
  100. '_sys_txt_quill_tooltip_link_popup_header',
  101. ]);
  102. // initialize editor
  103. $sInitEditor = $this->_replaceMarkers(self::$CONF_COMMON, array(
  104. 'bx_var_custom_init' => $sCustomInit,
  105. 'bx_var_selector' => bx_js_string($sSelector, BX_ESCAPE_STR_APOS),
  106. 'bx_var_query_params' => isset($aAttrs['query_params']) ? json_encode($aAttrs['query_params']) : "''",
  107. 'bx_var_form_id' => $aAttrs['form_id'],
  108. 'toolbar' => $sToolbarItems ? '[' . $sToolbarItems . ']' : 'false',
  109. 'bx_var_css_additional_class' => $sToolbarItems ? '' : 'bx-form-input-html-quill-empty',
  110. 'bx_var_element_name' => str_replace(['-', ' '], '_', $aAttrs['element_name']),
  111. 'bx_var_editor_name' => $sEditorName,
  112. 'bx_var_skin' => bx_js_string($this->_aObject['skin'], BX_ESCAPE_STR_APOS),
  113. 'bx_url_root' => bx_js_string(BX_DOL_URL_ROOT, BX_ESCAPE_STR_APOS)
  114. ));
  115. $sInitCallBack = "
  116. bQuillEditorInited = true;
  117. Quill.register('modules/imageUploader', ImageUploader);
  118. " . $sInitEditor;
  119. if ($bDynamicMode) {
  120. list($aJs, $aCss) = $this->_getJsCss(true);
  121. $sScript = "var " . $sEditorName . "; " . $this->_oTemplate->addJsPreloaded($aJs, $sInitCallBack, "typeof bQuillEditorInited === 'undefined'", $sInitEditor);
  122. $sScript = $this->_oTemplate->_wrapInTagJsCode($sScript);
  123. $sScript = $this->_oTemplate->addCss($aCss, true) . $sScript;
  124. } else {
  125. $sScript = "var " . $sEditorName . "; " . $this->_oTemplate->addJsCodeOnLoad($sInitCallBack);
  126. $sScript = $this->_oTemplate->_wrapInTagJsCode($sScript);
  127. }
  128. return $this->_addJsCss($bDynamicMode) . $sScript;
  129. }
  130. /**
  131. * Add css/js files which are needed for editor display and functionality.
  132. */
  133. protected function _addJsCss($bDynamicMode = false, $sInitEditor = '')
  134. {
  135. if ($bDynamicMode)
  136. return '';
  137. if ($this->_bJsCssAdded)
  138. return '';
  139. list($aJs, $aCss) = $this->_getJsCss();
  140. $this->_oTemplate->addJs($aJs);
  141. $this->_oTemplate->addCss($aCss);
  142. $this->_bJsCssAdded = true;
  143. return '';
  144. }
  145. protected function _getJsCss($bUseUrlsForJs = false)
  146. {
  147. $sJsPrefix = $bUseUrlsForJs ? BX_DOL_URL_PLUGINS_PUBLIC : BX_DIRECTORY_PATH_PLUGINS_PUBLIC;
  148. $sJsPrefixRoot = $bUseUrlsForJs ? BX_DOL_URL_ROOT .'inc/js/' : BX_DIRECTORY_PATH_INC . 'js/';
  149. $sJsSuffix = $bUseUrlsForJs ? '' : '|';
  150. $aJs = array(
  151. $sJsPrefix . 'highlight/' . $sJsSuffix . 'highlight.min.js',
  152. $sJsPrefix . 'quill/' . $sJsSuffix . 'quill.min.js',
  153. $sJsPrefix . 'quill/' . $sJsSuffix . 'quill.mention.js',
  154. $sJsPrefix . 'quill/' . $sJsSuffix . 'quill.imageUploader.min.js',
  155. $sJsPrefix . 'quill/' . $sJsSuffix . 'image-resize.min.js',
  156. $sJsPrefixRoot . $sJsSuffix . 'editor.quill.js',
  157. );
  158. $sCss = 'editor.less';
  159. $aCss = BxDolTemplate::getInstance()->_lessCss(array(
  160. 'path' => $this->_oTemplate->getCssPath($sCss),
  161. 'url' => $this->_oTemplate->getCssUrl($sCss)
  162. ));
  163. $aCss = array_merge($aCss, array(
  164. BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'quill/|quill.' . $this->_aObject['skin'] . '.css',
  165. BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'quill/|quill.mention.css',
  166. BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'highlight/|default.min.css',
  167. BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'quill/quill.imageUploader.min.css',
  168. BX_DIRECTORY_PATH_BASE . 'css/|editor.quill.css',
  169. ));
  170. return array($aJs, $aCss);
  171. }
  172. }
  173. /** @} */