Viewing file:  class-vc-automapper.php (15.79 KB) -rw-rw-rw-
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* WPBakery Visual Composer Plugin
*
* @package VPBakeryVisualComposer
*
*/
if ( ! class_exists( 'Vc_Automap_Model' ) ) {
/**
* Shortcode as model for automapper. Provides crud functionality for storing data for shortcodes that mapped by ATM
*
* @see Vc_Automapper
* @since 4.1
*/
class Vc_Automap_Model {
protected static $option_name = 'vc_automapped_shortcodes';
protected static $option_data;
public $id = false;
protected $data;
protected $vars = array( 'tag', 'name', 'category', 'description', 'params' );
function __construct( $d ) {
$this->loadOptionData();
$this->id = is_array( $d ) && isset( $d['id'] ) ? $d['id'] : $d;
if ( is_array( $d ) ) $this->data = stripslashes_deep( $d );
foreach ( $this->vars as $var ) {
$this->$var = $this->get( $var );
}
}
static function findAll() {
self::loadOptionData();
$records = array();
foreach ( self::$option_data as $id => $record ) {
$record['id'] = $id;
$model = new Vc_Automap_Model( $record );
if ( $model ) $records[] = $model;
}
return $records;
}
final protected static function loadOptionData() {
if ( is_null( self::$option_data ) ) self::$option_data = get_option( self::$option_name );
if ( ! self::$option_data ) self::$option_data = array();
return self::$option_data;
}
function get( $key ) {
if ( is_null( $this->data ) ) $this->data = isset( self::$option_data[$this->id] ) ? self::$option_data[$this->id] : array();
return isset( $this->data[$key] ) ? $this->data[$key] : null;
}
function set( $attr, $value = null ) {
if ( is_array( $attr ) ) {
foreach ( $attr as $key => $value ) {
$this->set( $key, $value );
}
} elseif ( ! is_null( $value ) ) {
$this->$attr = $value;
}
}
function save() {
if ( ! $this->isValid() ) return false;
foreach ( $this->vars as $var ) {
$this->data[$var] = $this->$var;
}
return $this->saveOption();
}
function delete() {
return $this->deleteOption();
}
public function isValid() {
if ( ! is_string( $this->name ) || empty( $this->name ) ) {
return false;
}
if ( ! preg_match( '/^\S+$/', $this->tag ) ) return false;
return true;
}
protected function saveOption() {
self::$option_data[$this->id] = $this->data;
return update_option( self::$option_name, self::$option_data );
}
protected function deleteOption() {
unset( self::$option_data[$this->id] );
return update_option( self::$option_name, self::$option_data );
}
}
}
if ( ! class_exists( 'Vc_Automapper' ) ) {
/**
* Automated shortcode mapping
*
* Automapper adds settings tab for VC settings tabs with ability to map custom shortcodes to VC editors,
* if shortcode is not mapped by default or developers haven't done this yet.
* No more shortcode copy/paste. Add any third party shortcode to the list of VC menu elements for reuse.
* Edit params, values and description.
*
* @since 4.1
*/
class Vc_Automapper {
protected static $disabled = false;
public function __construct() {
$this->title = __( 'My shortcodes', 'js_composer' );
}
public function addAjaxActions() {
add_action( 'wp_ajax_vc_automapper', array( &$this, 'goAction' ) );
}
public function build() {
wp_register_script( 'wpb_js_composer_automapper', vc_asset_url( 'js/backend/composer-automapper.js' ), array( 'wpb_js_composer_settings', 'backbone', 'shortcode' ), WPB_VC_VERSION, true ); // TODO: remove to automapper render
wp_enqueue_script( 'wpb_js_composer_automapper' );
wp_localize_script( 'wpb_js_composer_automapper', 'i18nLocaleVcAutomapper', array(
'are_you_sure_delete' => __( 'Are you sure you want to delete this shortcode?', 'js_composer' ),
'are_you_sure_delete_param' => __( "Are you sure you want to delete the shortcode's param?", 'js_composer' ),
'my_shortcodes_category' => __( 'My shortcodes', 'js_composer' ),
'error_shortcode_name_is_required' => __( "Shortcode name is required.", 'js_composer' ),
'error_enter_valid_shortcode_tag' => __( "Please enter valid shortcode tag.", 'js_composer' ),
'error_enter_required_fields' => __( "Please enter all required fields for params.", 'js_composer' ),
'new_shortcode_mapped' => __( 'New shortcode mapped from string!', 'js_composer' ),
'shortcode_updated' => __( 'Shortcode updated!', 'js_composer' ),
'error_content_param_not_manually' => __( 'Content param can not be added manually, please use checkbox.', 'js_composer' ),
'error_param_already_exists' => __( 'Param %s already exists. Param names must be unique.', 'js_composer' ),
'error_wrong_param_name' => __( 'Please use only letters, numbers and underscore for param name', 'js_composer' ),
'error_enter_valid_shortcode' => __( 'Please enter valid shortcode to parse!', 'js_composer' )
) );
}
// Render methods {{
/**
* Builds html for Automapper CRUD like administration block
*
* @return bool
*/
public function renderHtml() {
if ( $this->disabled() ) return false;
?>
<div class="tab_intro">
<p
class="description"><?php _e( 'Use Visual Composer Shortcode Mapper in order to add your custom or 3rd party vendors shortcodes to the list of Visual Composer elements menu. In order to map shortcode you need it to be already installed on your WordPress site.', 'js_composer' ) ?></p>
</div>
<div class="vc_automapper-toolbar"><a href="#" class="button button-primary"
id="vc_automapper-add-btn"><?php _e( 'Map shortcode', 'js_composer' ) ?></a>
</div>
<ul class="vc_automapper-list">
</ul>
<?php $this->renderTemplates() ?>
<?php
return true;
}
public function renderListItem( $shortcode ) {
echo '<li class="vc_automapper-item" data-item-id="">'
. '<label>' . $shortcode->name . '</label>'
. '<span class="vc_automapper-item-controls">'
. '<a href="#" class="vc_automapper-edit-btn" data-id="' . $shortcode->id . '" data-tag="' . $shortcode->tag . '"></a>'
. '<a href="#" class="vc_automapper-delete-btn" data-id="' . $shortcode->id . '" data-tag="' . $shortcode->tag . '"></a>'
. '</span></li>';
}
public function renderMapFormTpl() {
?>
<script type="text/html" id="vc_automapper-add-form-tpl">
<label for="vc_atm-shortcode-string"
class="vc_info"><?php _e( 'Please enter shortcode string', 'js_composer' ) ?></label>
<div class="vc_wrapper">
<div class="vc_string">
<input id="vc_atm-shortcode-string" placeholder="<?php _e( 'Please enter valid shortcode' ) ?>"
type="text" class="vc_atm-string">
</div>
<div class="vc_buttons">
<a href="#" id="vc_atm-parse-string"
class="button button-primary vc_parse-btn"><?php _e( 'Parse shortcode', 'js_composer' ) ?></a>
<a href="#" class="button vc_atm-cancel"><?php _e( 'Cancel', 'js_composer' ) ?></a>
</div>
</div>
<span
class="description"><?php _e( 'Please enter valid shortcode like [my_shortcode first_param="first_param_value"]My shortcode content[/my_shortcode]', 'js_composer' ) ?></span>
</div>
</script>
<script type="text/html" id="vc_automapper-item-complex-tpl">
<div class="widget-top">
<div class="widget-title-action">
<a class="widget-action hide-if-no-js" href="#"></a>
<a class="widget-control-edit hide-if-js">
<span class="edit vc_automapper-edit-btn">Edit</span>
<span class="add vc_automapper-delete-btn">Add</span>
<span class="screen-reader-text">Search</span>
</a>
</div>
<div class="widget-title"><h4>{{ name }}<span class="in-widget-title"></span></h4></div>
</div>
<div class="widget-inside">
</div>
</script>
<script type="text/html" id="vc_automapper-form-tpl">
<input type="hidden" name="name" id="vc_atm-name" value="{{ name }}">
<div class="vc_shortcode-preview" id="vc_shortcode-preview">
{{{ shortcode_preview }}}
</div>
<div class="vc_line"></div>
<div class="vc_wrapper">
<h4 class="vc_h"><?php _e( 'General information' ) ?></h4>
<div class="vc_field vc_tag">
<label for="vc_atm-tag"><?php _e( 'Tag:', 'js_composer' ) ?></label>
<input type="text" name="tag" id="vc_atm-tag" value="{{ tag }}">
</div>
<div class="vc_field vc_description">
<label for="vc_atm-description"><?php _e( 'Description:', 'js_composer' ) ?></label>
<textarea name="description" id="vc_atm-description">{{ description }}</textarea>
</div>
<div class="vc_field vc_category">
<label for="vc_atm-category"><?php _e( 'Category:', 'js_composer' ) ?></label>
<input type="text" name="category" id="vc_atm-category" value="{{ category }}">
<span class="description"><?php __( 'Comma separated categories names' ) ?></span>
</div>
<div class="vc_field vc_is-container">
<label for="vc_atm-is-container"><input type="checkbox" name="is_container" id="vc_atm-is-container"
value=""> <?php _e( 'Include content param into shortcode', 'js_composer' ) ?>
</label>
</div>
</div>
<div class="vc_line"></div>
<div class="vc_wrapper">
<h4 class="vc_h"><?php _e( 'Shortcode parameters' ) ?></h4>
<a href="#" id="vc_atm-add-param" class="button vc_add-param">+ Add param</a>
<div class="vc_params" id="vc_atm-params-list"></div>
</div>
<div class="vc_buttons">
<a href="#" id="vc_atm-save"
class="button button-primary"><?php _e( 'Save changes', 'js_composer' ) ?></a>
<a href="#" class="button vc_atm-cancel"><?php _e( 'Cancel', 'js_composer' ) ?></a>
<a href="#" class="button vc_atm-delete"><?php _e( 'Delete', 'js_composer' ) ?></a>
</div>
</script>
<script type="text/html" id="vc_atm-form-param-tpl">
<div class="vc_buttons">
<a href="#" class="vc_move-param"></a>
<a href="#" class="vc_delete-param"></a>
</div>
<div class="vc_fields">
<div class="vc_param_name vc_param-field">
<label><?php _e( 'Param name', 'js_composer' ) ?></label>
<# if(param_name === 'content'){#>
<span class="vc_content"><?php _e( 'Content', 'js_composer' ) ?></span>
<input type="text" style="visibility: hidden;" name="param_name" value="{{ param_name }}"
placeholder="<?php _e( 'Required value', 'js_composer' ) ?>" class="vc_param-name"
data-system="true">
<span class="description"
style="visibility: hidden;"><?php _e( 'Please use only letters, numbers and underscore.', 'js_composer' ) ?></span>
<# } else { #>
<input type="text" name="param_name" value="{{ param_name }}"
placeholder="<?php _e( 'Required value', 'js_composer' ) ?>" class="vc_param-name">
<span
class="description"><?php _e( 'Please use only letters, numbers and underscore.', 'js_composer' ) ?></span>
<# } #>
</div>
<div class="vc_heading vc_param-field">
<label><?php _e( 'Heading', 'js_composer' ) ?></label>
<input type="text" name="heading" value="{{ heading }}"
placeholder="<?php _e( 'Required value', 'js_composer' ) ?>">
<span
class="description"><?php _e( 'Heading for field in shortcode edit form.', 'js_composer' ) ?></span>
</div>
<div class="vc_type vc_param-field">
<label><?php _e( 'Field type', 'js_composer' ) ?></label>
<select name="type">
<option value=""><?php _e( 'Select field type', 'js_composer' ) ?></option>
<option
value="textfield"<?php echo '<# if(type==="textfield") { #> selected="selected"<# } #>' ?>><?php _e( 'Textfield', 'js_composer' ) ?></option>
<option
value="dropdown"<?php echo '<# if(type==="dropdown") { #> selected="selected"<# } #>' ?>><?php _e( 'Dropdown', 'js_composer' ) ?></option>
<option
value="textarea"<?php echo '<# if(type==="textarea") { #> selected="selected"<# } #>' ?>><?php _e( 'Textarea', 'js_composer' ) ?></option>
<# if(param_name === 'content'){#>
<option value="textarea_html"<?php echo '<# if(type==="textarea_html") { #> selected="selected"<# } #>' ?>><?php _e('Textarea HTML', 'js_composer') ?></option>
<# } #>
</select>
<span class="description"><?php _e( 'Field type for shortcode edit form.', 'js_composer' ) ?></span>
</div>
<div class="vc_value vc_param-field">
<label><?php _e( 'Default value', 'js_composer' ) ?></label>
<input type="text" name="value" value="{{ value }}" class="vc_param-value">
<span
class="description"><?php _e( 'Default value or list of values for dropdown type(separate by comma).', 'js_composer' ) ?></span>
</div>
<div class="description vc_param-field">
<label><?php _e( 'Description', 'js_composer' ) ?></label>
<textarea name="description" placeholder="">{{ description }}</textarea>
<span class="description"><?php _e( 'Explain param.', 'js_composer' ) ?></span>
</div>
</div>
</script>
<?php
}
public function renderTemplates() {
?>
<script type="text/html" id="vc_automapper-item-tpl">
<label class="vc_automapper-edit-btn">{{ name }}</label>
<span class="vc_automapper-item-controls">
<a href="#" class="vc_automapper-delete-btn" title="<?php _e( 'Delete', 'js_composer' ) ?>"></a>
<a href="#" class="vc_automapper-edit-btn" title="<?php _e( 'Edit', 'js_composer' ) ?>"></a>
</span>
</script>
<?php
$this->renderMapFormTpl();
}
// }}
// Action methods(CRUD) {{
public function goAction() {
$action = vc_post_param( 'vc_action' );
$this->result( $this->$action() );
}
public function create() {
$data = vc_post_param( 'data' );
$shortcode = new Vc_Automap_Model( $data );
return $shortcode->save();
}
public function update() {
$id = vc_post_param( 'id' );
$data = vc_post_param( 'data' );
$shortcode = new Vc_Automap_Model( $id );
if ( ! isset( $data['params'] ) ) $data['params'] = array();
$shortcode->set( $data );
return $shortcode->save();
}
public function delete() {
$id = vc_post_param( 'id' );
$shortcode = new Vc_Automap_Model( $id );
return $shortcode->delete();
}
public function read() {
return Vc_Automap_Model::findAll();
}
// }}
/**
* Ajax result output
*/
function result( $data ) {
echo is_array( $data ) || is_object( $data ) ? json_encode( $data ) : $data;
die();
}
/**
* Setter/Getter for Disabling Automapper
*
* @static
* @param bool $disable
*/
// {{
public static function setDisabled( $disable = true ) {
self::$disabled = $disable;
}
public static function disabled() {
return self::$disabled;
}
// }}
/**
* Setter/Getter for Automapper title
*
* @static
* @param string $title
*/
// {{
public function setTitle( $title ) {
$this->title = $title;
}
public function title() {
return $this->title;
}
// }}
public static function map() {
$shortcodes = Vc_Automap_Model::findAll();
foreach ( $shortcodes as $shortcode ) {
vc_map( array(
"name" => $shortcode->name,
"base" => $shortcode->tag,
"category" => vc_atm_build_categories_array( $shortcode->category ),
"description" => $shortcode->description,
"params" => vc_atm_build_params_array( $shortcode->params ),
"show_settings_on_create" => ! empty( $shortcode->params ),
"atm" => true,
"icon" => 'icon-wpb-atm'
) );
}
}
}
}
// Helpers
if ( ! function_exists( 'vc_atm_build_categories_array' ) ) {
function vc_atm_build_categories_array( $string ) {
return array_map( 'vc_atm_textdomain_category', explode( ',', preg_replace( '/\,\s+/', ',', trim( $string ) ) ) );
}
function vc_atm_textdomain_category( $value ) {
return __( $value, 'js_composer' );
}
}
if ( ! function_exists( 'vc_atm_build_params_array' ) ) {
function vc_atm_build_params_array( $array ) {
$params = array();
if ( is_array( $array ) ) {
foreach ( $array as $param ) {
if ( $param['type'] === 'dropdown' ) $param['value'] = explode( ',', preg_replace( '/\,\s+/', ',', trim( $param['value'] ) ) );
$params[] = $param;
}
}
return $params;
}
}
|