209 lines
5.1 KiB
PHP
209 lines
5.1 KiB
PHP
<?php
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
die( '-1' );
|
|
}
|
|
|
|
/**
|
|
* WPBakery WPBakery Page Builder shortcodes attributes class.
|
|
*
|
|
* This class and functions represents ability which will allow you to create attributes settings fields to
|
|
* control new attributes.
|
|
* New attributes can be added to shortcode settings by using param array in wp_map function
|
|
*
|
|
* @package WPBakeryPageBuilder
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* Shortcode params class allows to create new params types.
|
|
* class WpbakeryShortcodeParams
|
|
* @since 4.2
|
|
*/
|
|
class WpbakeryShortcodeParams {
|
|
/**
|
|
* @since 4.2
|
|
* @var array - store shortcode attributes types
|
|
*/
|
|
protected static $params = array();
|
|
/**
|
|
* @since 4.2
|
|
* @var array - store shortcode javascript files urls
|
|
*/
|
|
protected static $scripts = array();
|
|
/**
|
|
* @since 4.2
|
|
* @var array
|
|
*/
|
|
protected static $enqueue_script = array();
|
|
/**
|
|
* @since 4.2
|
|
* @var array
|
|
*/
|
|
protected static $scripts_to_register = array();
|
|
/**
|
|
* @since 4.2
|
|
* @var bool
|
|
*/
|
|
protected static $is_enqueue = false;
|
|
/**
|
|
* @since 4.7
|
|
* @var array - store params not required to init
|
|
*/
|
|
protected static $optional_init_params = array();
|
|
|
|
/**
|
|
* Get list of params that need to be initialized
|
|
*
|
|
* @return string[]
|
|
*/
|
|
public static function getRequiredInitParams() {
|
|
$all_params = array_keys( self::$params );
|
|
$optional_params = apply_filters( 'vc_edit_form_fields_optional_params', self::$optional_init_params );
|
|
$required_params = array_diff( $all_params, $optional_params );
|
|
|
|
return $required_params;
|
|
}
|
|
|
|
/**
|
|
* @since 4.2
|
|
*
|
|
* @param $script
|
|
*/
|
|
public static function registerScript( $script ) {
|
|
$script_name = 'vc_edit_form_enqueue_script_' . md5( $script );
|
|
self::$enqueue_script[] = array(
|
|
'name' => $script_name,
|
|
'script' => $script,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @deprecated 4.4 - TODO check for usage
|
|
* @not used
|
|
* @since 4.2
|
|
*/
|
|
public static function enqueueScripts() {
|
|
// _deprecated_function( 'WpbakeryShortcodeParams::enqueueScripts', '4.4' );
|
|
if ( self::isEnqueue() ) {
|
|
foreach ( self::$enqueue_script as $item ) {
|
|
wp_register_script( $item['name'], $item['script'], array(
|
|
'jquery',
|
|
'wp-color-picker',
|
|
), WPB_VC_VERSION, true );
|
|
wp_enqueue_script( $item['name'] );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Create new attribute type
|
|
*
|
|
* @static
|
|
* @since 4.2
|
|
*
|
|
* @param $name - attribute name
|
|
* @param $form_field_callback - hook, will be called when settings form is shown and attribute added to shortcode
|
|
* param list
|
|
* @param $script_url - javascript file url which will be attached at the end of settings form.
|
|
*
|
|
* @return bool - return true if attribute type created
|
|
*/
|
|
public static function addField( $name, $form_field_callback, $script_url = null ) {
|
|
|
|
$result = false;
|
|
if ( ! empty( $name ) && ! empty( $form_field_callback ) ) {
|
|
self::$params[ $name ] = array(
|
|
'callbacks' => array(
|
|
'form' => $form_field_callback,
|
|
),
|
|
);
|
|
$result = true;
|
|
|
|
if ( is_string( $script_url ) && ! in_array( $script_url, self::$scripts ) ) {
|
|
self::registerScript( $script_url );
|
|
self::$scripts[] = $script_url;
|
|
}
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Calls hook for attribute type
|
|
* @since 4.2
|
|
* @static
|
|
*
|
|
* @param $name - attribute name
|
|
* @param $param_settings - attribute settings from shortcode
|
|
* @param $param_value - attribute value
|
|
* @param $tag - attribute tag
|
|
*
|
|
* @return mixed|string - returns html which will be render in hook
|
|
*/
|
|
public static function renderSettingsField( $name, $param_settings, $param_value, $tag ) {
|
|
if ( isset( self::$params[ $name ]['callbacks']['form'] ) ) {
|
|
return call_user_func( self::$params[ $name ]['callbacks']['form'], $param_settings, $param_value, $tag );
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* List of javascript files urls for shortcode attributes.
|
|
* @since 4.2
|
|
* @static
|
|
* @return array - list of js scripts
|
|
*/
|
|
|
|
public static function getScripts() {
|
|
return self::$scripts;
|
|
}
|
|
|
|
/**
|
|
* @since 4.2
|
|
*
|
|
* @param $value
|
|
*/
|
|
public static function setEnqueue( $value ) {
|
|
self::$is_enqueue = (boolean) $value;
|
|
}
|
|
|
|
/**
|
|
* @since 4.2
|
|
* @return bool
|
|
*/
|
|
public static function isEnqueue() {
|
|
return self::$is_enqueue;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Helper function to register new shortcode attribute hook.
|
|
*
|
|
* @param $name - attribute name
|
|
* @param $form_field_callback - hook, will be called when settings form is shown and attribute added to shortcode
|
|
* param list
|
|
* @param $script_url - javascript file url which will be attached at the end of settings form.
|
|
*
|
|
* @since 4.4
|
|
* @return bool
|
|
*/
|
|
function vc_add_shortcode_param( $name, $form_field_callback, $script_url = null ) {
|
|
return WpbakeryShortcodeParams::addField( $name, $form_field_callback, $script_url );
|
|
}
|
|
|
|
/**
|
|
* Call hook for attribute.
|
|
*
|
|
* @param $name - attribute name
|
|
* @param $param_settings - attribute settings from shortcode
|
|
* @param $param_value - attribute value
|
|
* @param $tag - attribute tag
|
|
*
|
|
* @since 4.4
|
|
* @return mixed|string - returns html which will be render in hook
|
|
*/
|
|
function vc_do_shortcode_param_settings_field( $name, $param_settings, $param_value, $tag ) {
|
|
return WpbakeryShortcodeParams::renderSettingsField( $name, $param_settings, $param_value, $tag );
|
|
}
|