class-vc-automapper.php 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392
  1. <?php
  2. if ( ! defined( 'ABSPATH' ) ) {
  3. die( '-1' );
  4. }
  5. if ( ! class_exists( 'Vc_Automapper' ) ) {
  6. /**
  7. * Automated shortcode mapping
  8. *
  9. * Automapper adds settings tab for VC settings tabs with ability to map custom shortcodes to VC editors,
  10. * if shortcode is not mapped by default or developers haven't done this yet.
  11. * No more shortcode copy/paste. Add any third party shortcode to the list of VC menu elements for reuse.
  12. * Edit params, values and description.
  13. *
  14. * @since 4.1
  15. */
  16. class Vc_Automapper {
  17. /**
  18. * @var bool
  19. */
  20. protected static $disabled = false;
  21. protected $title;
  22. /**
  23. *
  24. */
  25. public function __construct() {
  26. $this->title = esc_attr__( 'Shortcode Mapper', 'js_composer' );
  27. }
  28. /**
  29. *
  30. */
  31. public function addAjaxActions() {
  32. add_action( 'wp_ajax_vc_automapper_create', array(
  33. $this,
  34. 'create',
  35. ) );
  36. add_action( 'wp_ajax_vc_automapper_read', array(
  37. $this,
  38. 'read',
  39. ) );
  40. add_action( 'wp_ajax_vc_automapper_update', array(
  41. $this,
  42. 'update',
  43. ) );
  44. add_action( 'wp_ajax_vc_automapper_delete', array(
  45. $this,
  46. 'delete',
  47. ) );
  48. return $this;
  49. }
  50. /**
  51. * Builds html for Automapper CRUD like administration block
  52. *
  53. * @return bool
  54. */
  55. public function renderHtml() {
  56. if ( $this->disabled() ) {
  57. return false;
  58. }
  59. ?>
  60. <div class="tab_intro">
  61. <p><?php esc_html_e( 'WPBakery Page Builder Shortcode Mapper adds custom 3rd party vendors shortcodes to the list of WPBakery Page Builder content elements menu (Note: to map shortcode it needs to be installed on site).', 'js_composer' ); ?></p>
  62. </div>
  63. <div class="vc_automapper-toolbar">
  64. <a href=javascript:;" class="button button-primary"
  65. id="vc_automapper-add-btn"><?php esc_html_e( 'Map Shortcode', 'js_composer' ); ?></a>
  66. </div>
  67. <ul class="vc_automapper-list">
  68. </ul>
  69. <?php $this->renderTemplates(); ?>
  70. <?php
  71. return true;
  72. }
  73. /**
  74. * @param $shortcode
  75. */
  76. public function renderListItem( $shortcode ) {
  77. echo sprintf( '<li class="vc_automapper-item" data-item-id=""><label>%s</label><span class="vc_automapper-item-controls"><a href="javascript:;" class="vc_automapper-edit-btn" data-id="%s" data-tag="%s"></a><a href="javascript:;" class="vc_automapper-delete-btn" data-id="%s" data-tag="%s"></a></span></li>', esc_html( $shortcode->name ), esc_attr( $shortcode->id ), esc_attr( $shortcode->tag ), esc_attr( $shortcode->id ), esc_attr( $shortcode->tag ) );
  78. }
  79. /**
  80. *
  81. */
  82. public function renderMapFormTpl() {
  83. $custom_tag = 'script'; // Maybe use html shadow dom or ajax response for templates
  84. ?>
  85. <<?php echo esc_attr( $custom_tag ); ?> type="text/html" id="vc_automapper-add-form-tpl">
  86. <label for="vc_atm-shortcode-string"
  87. class="vc_info"><?php esc_html_e( 'Shortcode string', 'js_composer' ); ?></label>
  88. <div class="vc_wrapper">
  89. <div class="vc_string">
  90. <input id="vc_atm-shortcode-string"
  91. placeholder="<?php esc_attr_e( 'Please enter valid shortcode', 'js_composer' ); ?>"
  92. type="text" class="vc_atm-string">
  93. </div>
  94. <div class="vc_buttons">
  95. <a href="#" id="vc_atm-parse-string"
  96. class="button button-primary vc_parse-btn"><?php esc_attr_e( 'Parse Shortcode', 'js_composer' ); ?></a>
  97. <a href="#" class="button vc_atm-cancel"><?php esc_attr_e( 'Cancel', 'js_composer' ); ?></a>
  98. </div>
  99. </div>
  100. <span
  101. class="description"><?php esc_html_e( 'Enter valid shortcode (Example: [my_shortcode first_param="first_param_value"]My shortcode content[/my_shortcode]).', 'js_composer' ); ?></span>
  102. </<?php echo esc_attr( $custom_tag ); ?>>
  103. <<?php echo esc_attr( $custom_tag ); ?> type="text/html" id="vc_automapper-item-complex-tpl">
  104. <div class="widget-top">
  105. <div class="widget-title-action">
  106. <button type="button" class="widget-action hide-if-no-js" aria-expanded="true">
  107. <span class="screen-reader-text"><?php esc_html_e( 'Edit widget: Search', 'js_composer' ); ?></span>
  108. <span class="toggle-indicator" aria-hidden="true"></span>
  109. </button>
  110. </div>
  111. <div class="widget-title"><h4>{{ name }}<span class="in-widget-title"></span></h4></div>
  112. </div>
  113. <div class="widget-inside">
  114. </div>
  115. </<?php echo esc_attr( $custom_tag ); ?>>
  116. <<?php echo esc_attr( $custom_tag ); ?> type="text/html" id="vc_automapper-form-tpl">
  117. <input type="hidden" name="name" id="vc_atm-name" value="{{ name }}">
  118. <div class="vc_shortcode-preview" id="vc_shortcode-preview">
  119. {{{ shortcode_preview }}}
  120. </div>
  121. <div class="vc_line"></div>
  122. <div class="vc_wrapper">
  123. <h4 class="vc_h"><?php esc_html_e( 'General Information', 'js_composer' ); ?></h4>
  124. <div class="vc_field vc_tag">
  125. <label for="vc_atm-tag"><?php esc_html_e( 'Tag:', 'js_composer' ); ?></label>
  126. <input type="text" name="tag" id="vc_atm-tag" value="{{ tag }}">
  127. </div>
  128. <div class="vc_field vc_description">
  129. <label for="vc_atm-description"><?php esc_html_e( 'Description:', 'js_composer' ); ?></label>
  130. <textarea name="description" id="vc_atm-description">{{ description }}</textarea>
  131. </div>
  132. <div class="vc_field vc_category">
  133. <label for="vc_atm-category"><?php esc_html_e( 'Category:', 'js_composer' ); ?></label>
  134. <input type="text" name="category" id="vc_atm-category" value="{{ category }}">
  135. <span
  136. class="description"><?php esc_html_e( 'Comma separated categories names', 'js_composer' ); ?></span>
  137. </div>
  138. <div class="vc_field vc_is-container">
  139. <label for="vc_atm-is-container"><input type="checkbox" name="is_container"
  140. id="vc_atm-is-container"
  141. value=""> <?php esc_html_e( 'Include content param into shortcode', 'js_composer' ); ?>
  142. </label>
  143. </div>
  144. </div>
  145. <div class="vc_line"></div>
  146. <div class="vc_wrapper">
  147. <h4 class="vc_h"><?php esc_html_e( 'Shortcode Parameters', 'js_composer' ); ?></h4>
  148. <a href="#" id="vc_atm-add-param"
  149. class="button vc_add-param">+ <?php esc_html_e( 'Add Param', 'js_composer' ); ?></a>
  150. <div class="vc_params" id="vc_atm-params-list"></div>
  151. </div>
  152. <div class="vc_buttons">
  153. <a href="#" id="vc_atm-save"
  154. class="button button-primary"><?php esc_html_e( 'Save Changes', 'js_composer' ); ?></a>
  155. <a href="#" class="button vc_atm-cancel"><?php esc_html_e( 'Cancel', 'js_composer' ); ?></a>
  156. <a href="#" class="button vc_atm-delete"><?php esc_html_e( 'Delete', 'js_composer' ); ?></a>
  157. </div>
  158. </<?php echo esc_attr( $custom_tag ); ?>>
  159. <<?php echo esc_attr( $custom_tag ); ?> type="text/html" id="vc_atm-form-param-tpl">
  160. <div class="vc_controls vc_controls-row vc_clearfix"><a
  161. class="vc_control column_move vc_column-move vc_move-param" href="#"
  162. title="<?php esc_html_e( 'Drag row to reorder', 'js_composer' ); ?>" data-vc-control="move"><i
  163. class="vc-composer-icon vc-c-icon-dragndrop"></i></a><span class="vc_row_edit_clone_delete"><a
  164. class="vc_control column_delete vc_delete-param" href="#"
  165. title="<?php esc_html_e( 'Delete this param', 'js_composer' ); ?>"><i class="vc-composer-icon vc-c-icon-delete_empty"></i></a></span>
  166. </div>
  167. <div class="wpb_element_wrapper">
  168. <div class="vc_row vc_row-fluid wpb_row_container">
  169. <div class="wpb_vc_column wpb_sortable vc_col-sm-12 wpb_content_holder vc_empty-column">
  170. <div class="wpb_element_wrapper">
  171. <div class="vc_fields vc_clearfix">
  172. <div class="vc_param_name vc_param-field">
  173. <label><?php esc_html_e( 'Param name', 'js_composer' ); ?></label>
  174. <# if ( 'content' === param_name) { #>
  175. <span class="vc_content"><?php esc_html_e( 'Content', 'js_composer' ); ?></span>
  176. <input type="text" style="display: none;" name="param_name"
  177. value="{{ param_name }}"
  178. placeholder="<?php esc_attr_e( 'Required value', 'js_composer' ); ?>"
  179. class="vc_param-name"
  180. data-system="true">
  181. <span class="description"
  182. style="display: none;"><?php esc_html_e( 'Use only letters, numbers and underscore.', 'js_composer' ); ?></span>
  183. <# } else { #>
  184. <input type="text" name="param_name" value="{{ param_name }}"
  185. placeholder="<?php esc_attr_e( 'Required value', 'js_composer' ); ?>"
  186. class="vc_param-name">
  187. <span
  188. class="description"><?php esc_html_e( 'Please use only letters, numbers and underscore.', 'js_composer' ); ?></span>
  189. <# } #>
  190. </div>
  191. <div class="vc_heading vc_param-field">
  192. <label><?php esc_html_e( 'Heading', 'js_composer' ); ?></label>
  193. <input type="text" name="heading" value="{{ heading }}"
  194. placeholder="<?php esc_attr_e( 'Input heading', 'js_composer' ); ?>"
  195. <# if ( 'hidden' === type) { #>
  196. disabled="disabled"
  197. <# } #>>
  198. <span
  199. class="description"><?php esc_html_e( 'Heading for field in shortcode edit form.', 'js_composer' ); ?></span>
  200. </div>
  201. <div class="vc_type vc_param-field">
  202. <label><?php esc_html_e( 'Field type', 'js_composer' ); ?></label>
  203. <select name="type">
  204. <option value=""><?php esc_html_e( 'Select field type', 'js_composer' ); ?></option>
  205. <option
  206. value="textfield"<?php echo '<# if (type === "textfield") { #> selected<# } #>'; ?>><?php esc_html_e( 'Textfield', 'js_composer' ); ?></option>
  207. <option
  208. value="dropdown"<?php echo '<# if (type === "dropdown") { #> selected<# } #>'; ?>><?php esc_html_e( 'Dropdown', 'js_composer' ); ?></option>
  209. <option
  210. value="textarea"<?php echo '<# if(type==="textarea") { #> selected="selected"<# } #>'; ?>><?php esc_html_e( 'Textarea', 'js_composer' ); ?></option>
  211. <# if ( 'content' === param_name ) { #>
  212. <option
  213. value="textarea_html"<?php echo '<# if (type === "textarea_html") { #> selected<# } #>'; ?>><?php esc_html_e( 'Textarea HTML', 'js_composer' ); ?></option>
  214. <# } #>
  215. <option
  216. value="hidden"<?php echo '<# if (type === "hidden") { #> selected<# } #>'; ?>><?php esc_html_e( 'Hidden', 'js_composer' ); ?></option>
  217. </select>
  218. <span
  219. class="description"><?php esc_html_e( 'Field type for shortcode edit form.', 'js_composer' ); ?></span>
  220. </div>
  221. <div class="vc_value vc_param-field">
  222. <label><?php esc_html_e( 'Default value', 'js_composer' ); ?></label>
  223. <input type="text" name="value" value="{{ value }}" class="vc_param-value">
  224. <span
  225. class="description"><?php esc_html_e( 'Default value or list of values for dropdown type (Note: separate by comma).', 'js_composer' ); ?></span>
  226. </div>
  227. <div class="description vc_param-field">
  228. <label><?php esc_html_e( 'Description', 'js_composer' ); ?></label>
  229. <textarea name="description" placeholder=""
  230. <# if ( 'hidden' === type ) { #>
  231. disabled="disabled"
  232. <# } #> >{{ description
  233. }}</textarea>
  234. <span
  235. class="description"><?php esc_html_e( 'Enter description for parameter.', 'js_composer' ); ?></span>
  236. </div>
  237. </div>
  238. </div>
  239. </div>
  240. </div>
  241. </div>
  242. </<?php echo esc_attr( $custom_tag ); ?>>
  243. <?php
  244. }
  245. /**
  246. *
  247. */
  248. public function renderTemplates() {
  249. $custom_tag = 'script'; // Maybe use ajax resonse for template
  250. ?>
  251. <<?php echo esc_attr( $custom_tag ); ?> type="text/html" id="vc_automapper-item-tpl">
  252. <label class="vc_automapper-edit-btn">{{ name }}</label>
  253. <span class="vc_automapper-item-controls">
  254. <a href="#" class="vc_automapper-delete-btn" title="<?php esc_html_e( 'Delete', 'js_composer' ); ?>"></a>
  255. <a href="#" class="vc_automapper-edit-btn" title="<?php esc_html_e( 'Edit', 'js_composer' ); ?>"></a>
  256. </span>
  257. </<?php echo esc_attr( $custom_tag ); ?>>
  258. <?php
  259. $this->renderMapFormTpl();
  260. }
  261. public function create() {
  262. if ( ! vc_request_param( '_vcnonce' ) ) {
  263. return;
  264. }
  265. vc_user_access()->checkAdminNonce()->validateDie()->wpAny( 'manage_options' )->validateDie()->part( 'settings' )->can( 'vc-automapper-tab' )->validateDie();
  266. $data = vc_post_param( 'data' );
  267. $shortcode = new Vc_Automap_Model( $data );
  268. $this->result( $shortcode->save() );
  269. }
  270. public function update() {
  271. if ( ! vc_request_param( '_vcnonce' ) ) {
  272. return;
  273. }
  274. vc_user_access()->checkAdminNonce()->validateDie()->wpAny( 'manage_options' )->validateDie()->part( 'settings' )->can( 'vc-automapper-tab' )->validateDie();
  275. $id = (int) vc_post_param( 'id' );
  276. $data = vc_post_param( 'data' );
  277. $shortcode = new Vc_Automap_Model( $id );
  278. if ( ! isset( $data['params'] ) ) {
  279. $data['params'] = array();
  280. }
  281. $shortcode->set( $data );
  282. $this->result( $shortcode->save() );
  283. }
  284. public function delete() {
  285. if ( ! vc_request_param( '_vcnonce' ) ) {
  286. return;
  287. }
  288. vc_user_access()->checkAdminNonce()->validateDie()->wpAny( 'manage_options' )->validateDie()->part( 'settings' )->can( 'vc-automapper-tab' )->validateDie();
  289. $id = vc_post_param( 'id' );
  290. $shortcode = new Vc_Automap_Model( $id );
  291. $this->result( $shortcode->delete() );
  292. }
  293. public function read() {
  294. if ( ! vc_request_param( '_vcnonce' ) ) {
  295. return;
  296. }
  297. vc_user_access()->checkAdminNonce()->validateDie()->wpAny( 'manage_options' )->validateDie()->part( 'settings' )->can( 'vc-automapper-tab' )->validateDie();
  298. $this->result( Vc_Automap_Model::findAll() );
  299. }
  300. /**
  301. * Ajax result output
  302. *
  303. * @param $data
  304. */
  305. public function result( $data ) {
  306. if ( false !== $data ) {
  307. wp_send_json_success( $data );
  308. } else {
  309. wp_send_json_error( $data );
  310. }
  311. }
  312. /**
  313. * Setter/Getter for Disabling Automapper
  314. * @static
  315. *
  316. * @param bool $disable
  317. */
  318. public static function setDisabled( $disable = true ) {
  319. self::$disabled = $disable;
  320. }
  321. /**
  322. * @return bool
  323. */
  324. public static function disabled() {
  325. return self::$disabled;
  326. }
  327. /**
  328. * Setter/Getter for Automapper title
  329. *
  330. * @static
  331. *
  332. * @param string $title
  333. */
  334. public function setTitle( $title ) {
  335. $this->title = $title;
  336. }
  337. /**
  338. * @return string|void
  339. */
  340. public function title() {
  341. return $this->title;
  342. }
  343. /**
  344. *
  345. */
  346. public static function map() {
  347. $shortcodes = Vc_Automap_Model::findAll();
  348. foreach ( $shortcodes as $shortcode ) {
  349. vc_map( array(
  350. 'name' => $shortcode->name,
  351. 'base' => $shortcode->tag,
  352. 'category' => vc_atm_build_categories_array( $shortcode->category ),
  353. 'description' => $shortcode->description,
  354. 'params' => vc_atm_build_params_array( $shortcode->params ),
  355. 'show_settings_on_create' => ! empty( $shortcode->params ),
  356. 'atm' => true,
  357. 'icon' => 'icon-wpb-atm',
  358. ) );
  359. }
  360. }
  361. }
  362. }