a815fdf179
Escape everything that should be escaped. Add nonce checks where needed. Sanitize all inputs. Apply Code style changes across the codebase. Correct many deprecation notices. Optimize load order of many filters.
575 lines
14 KiB
PHP
575 lines
14 KiB
PHP
<?php
|
|
/**
|
|
* Creates a cart with the parameters of the purchase being placed.
|
|
*
|
|
* @package WP_Ultimo
|
|
* @subpackage Order
|
|
* @since 2.0.0
|
|
*/
|
|
|
|
namespace WP_Ultimo\Checkout\Signup_Fields;
|
|
|
|
// Exit if accessed directly
|
|
defined('ABSPATH') || exit;
|
|
|
|
/**
|
|
* Creates an cart with the parameters of the purchase being placed.
|
|
*
|
|
* @package WP_Ultimo
|
|
* @subpackage Checkout
|
|
* @since 2.0.0
|
|
*/
|
|
abstract class Base_Signup_Field {
|
|
|
|
/**
|
|
* Holds the field attributes.
|
|
*
|
|
* @since 2.0.0
|
|
* @var array
|
|
*/
|
|
protected $attributes;
|
|
|
|
/**
|
|
* Returns the type of the field.
|
|
*
|
|
* @since 2.0.0
|
|
* @return string
|
|
*/
|
|
abstract public function get_type();
|
|
|
|
/**
|
|
* Returns if this field should be present on the checkout flow or not.
|
|
*
|
|
* @since 2.0.0
|
|
* @return boolean
|
|
*/
|
|
abstract public function is_required();
|
|
|
|
/**
|
|
* Requires the title of the field/element type.
|
|
*
|
|
* This is used on the Field/Element selection screen.
|
|
*
|
|
* @since 2.0.0
|
|
* @return string
|
|
*/
|
|
abstract public function get_title();
|
|
|
|
/**
|
|
* Returns the description of the field/element.
|
|
*
|
|
* This is used as the title attribute of the selector.
|
|
*
|
|
* @since 2.0.0
|
|
* @return string
|
|
*/
|
|
abstract public function get_description();
|
|
|
|
/**
|
|
* Returns the tooltip of the field/element.
|
|
*
|
|
* This is used as the tooltip attribute of the selector.
|
|
*
|
|
* @since 2.0.0
|
|
* @return string
|
|
*/
|
|
abstract function get_tooltip();
|
|
|
|
/**
|
|
* Returns the icon to be used on the selector.
|
|
*
|
|
* Can be either a dashicon class or a wu-dashicon class.
|
|
*
|
|
* @since 2.0.0
|
|
* @return string
|
|
*/
|
|
abstract public function get_icon();
|
|
|
|
/**
|
|
* Returns the list of additional fields specific to this type.
|
|
*
|
|
* @since 2.0.0
|
|
* @return array
|
|
*/
|
|
abstract public function get_fields();
|
|
|
|
/**
|
|
* Returns the field/element actual field array to be used on the checkout form.
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @param array $attributes Attributes saved on the editor form.
|
|
* @return array An array of fields, not the field itself.
|
|
*/
|
|
abstract public function to_fields_array($attributes);
|
|
|
|
/**
|
|
* Set's if a field should not be available on the form creation.
|
|
*
|
|
* @since 2.0.0
|
|
* @return boolean
|
|
*/
|
|
public function is_hidden() {
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Defines if this field/element is related to site creation or not.
|
|
*
|
|
* @since 2.0.0
|
|
* @return boolean
|
|
*/
|
|
public function is_site_field() {
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Defines if this field/element is related to user/customer creation or not.
|
|
*
|
|
* @since 2.0.0
|
|
* @return boolean
|
|
*/
|
|
public function is_user_field() {
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns the field as an array that the form builder can understand.
|
|
*
|
|
* @since 2.0.0
|
|
* @return array
|
|
*/
|
|
public function get_field_as_type_option() {
|
|
|
|
return [
|
|
'title' => $this->get_title(),
|
|
'desc' => $this->get_description(),
|
|
'tooltip' => $this->get_tooltip(),
|
|
'type' => $this->get_type(),
|
|
'icon' => $this->get_icon(),
|
|
'required' => $this->is_required(),
|
|
'default_fields' => $this->default_fields(),
|
|
'force_attributes' => $this->force_attributes(),
|
|
'all_attributes' => $this->get_all_attributes(),
|
|
'fields' => [$this, 'get_editor_fields'],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Modifies the HTML attr array before sending it over to the form.
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @param array $html_attr The current attributes.
|
|
* @param string $field_name Field name.
|
|
* @return array
|
|
*/
|
|
public function get_editor_fields_html_attr($html_attr, $field_name) {
|
|
|
|
return $html_attr;
|
|
}
|
|
|
|
/**
|
|
* Get the tabs available for this field.
|
|
*
|
|
* @since 2.0.0
|
|
* @return array
|
|
*/
|
|
public function get_tabs() {
|
|
|
|
return [
|
|
'content',
|
|
'style',
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Gets the pre-filled value for the field.
|
|
*
|
|
* @since 2.0.0
|
|
* @return mixed
|
|
*/
|
|
public function get_value() {
|
|
|
|
$value = wu_get_isset($this->attributes, 'default_value', '');
|
|
|
|
$session = wu_get_session('signup');
|
|
|
|
$value_session = wu_get_isset($session->get('signup'), $this->attributes['id']);
|
|
|
|
if ($value_session) {
|
|
$value = $value_session;
|
|
}
|
|
|
|
if (wu_get_isset($this->attributes, 'from_request') && wu_get_isset($this->attributes, 'id')) {
|
|
$value = wu_request($this->attributes['id'], '');
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* Calculate the style attributes for the field.
|
|
*
|
|
* @since 2.0.4
|
|
* @return string
|
|
*/
|
|
public function calculate_style_attr() {
|
|
|
|
$styles = [];
|
|
|
|
$width = (int) wu_get_isset($this->attributes, 'width');
|
|
|
|
if ($width) {
|
|
if (100 !== $width) {
|
|
$styles[] = 'float: left';
|
|
|
|
$styles[] = sprintf('width: %s%%', $width);
|
|
}
|
|
} else {
|
|
$styles[] = 'clear: both';
|
|
}
|
|
|
|
return implode('; ', $styles);
|
|
}
|
|
|
|
/**
|
|
* Sets the config values for the current field.
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @param array $attributes Array containing settings for the field.
|
|
* @return void
|
|
*/
|
|
public function set_attributes($attributes): void {
|
|
|
|
$this->attributes = $attributes;
|
|
}
|
|
|
|
/**
|
|
* If you want to force a particular attribute to a value, declare it here.
|
|
*
|
|
* @since 2.0.0
|
|
* @return array
|
|
*/
|
|
public function force_attributes() {
|
|
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Default values for the editor fields.
|
|
*
|
|
* @since 2.0.0
|
|
* @return array
|
|
*/
|
|
public function defaults() {
|
|
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* List of keys of the default fields we want to display on the builder.
|
|
*
|
|
* @since 2.0.0
|
|
* @return array
|
|
*/
|
|
public function default_fields() {
|
|
|
|
return [
|
|
'id',
|
|
'name',
|
|
'placeholder',
|
|
'tooltip',
|
|
'default',
|
|
'required',
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Returns the editor fields.
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @param array $attributes The list of attributes of the field.
|
|
* @return array
|
|
*/
|
|
public function get_editor_fields($attributes = []) {
|
|
|
|
$final_field_list = $this->get_fields();
|
|
|
|
/*
|
|
* Checks if this is a site field
|
|
*/
|
|
if ($this->is_site_field()) {
|
|
$final_field_list[ '_site_notice_field_' . uniqid() ] = [
|
|
'type' => 'note',
|
|
'classes' => 'wu--mt-px',
|
|
'desc' => sprintf('<div class="wu-p-4 wu--m-4 wu-bg-blue-100 wu-text-blue-600 wu-border-t wu-border-l-0 wu-border-r-0 wu-border-b-0 wu-border-gray-300 wu-border-solid">%s</div>', __('This is a site-related field. For that reason, this field will not show up when no plans are present on the shopping cart.', 'wp-multisite-waas')),
|
|
'order' => 98.5,
|
|
];
|
|
}
|
|
|
|
/*
|
|
* Checks if this is a user field
|
|
*/
|
|
if ($this->is_user_field()) {
|
|
$final_field_list[ '_user_notice_field_' . uniqid() ] = [
|
|
'type' => 'note',
|
|
'classes' => 'wu--mt-px',
|
|
'desc' => sprintf('<div class="wu-p-4 wu--m-4 wu-bg-blue-100 wu-text-blue-600 wu-border-t wu-border-l-0 wu-border-r-0 wu-border-b-0 wu-border-gray-300 wu-border-solid">%s</div>', __('This is a customer-related field. For that reason, this field will not show up when the user is logged and already has a customer on file.', 'wp-multisite-waas')),
|
|
'order' => 98.5,
|
|
];
|
|
}
|
|
|
|
foreach ($final_field_list as $key => &$field) {
|
|
$field['html_attr'] = wu_get_isset($field, 'html_attr', []);
|
|
|
|
$value = wu_get_isset($attributes, $key, null);
|
|
|
|
$field['default'] = wu_get_isset($this->defaults(), $key, '');
|
|
|
|
if (null === $value) {
|
|
$value = $field['default'];
|
|
}
|
|
|
|
if (wu_get_isset($field['html_attr'], 'data-model')) {
|
|
$model_name = wu_get_isset($field['html_attr'], 'data-model', 'product');
|
|
|
|
$models = explode(',', (string) $value);
|
|
|
|
$func_name = "wu_get_{$model_name}";
|
|
|
|
if (function_exists($func_name)) {
|
|
$selected = array_map(
|
|
function ($id) use ($func_name) {
|
|
|
|
$model = call_user_func($func_name, absint($id));
|
|
|
|
if ( ! $model) {
|
|
return false;
|
|
}
|
|
|
|
return $model->to_search_results();
|
|
},
|
|
$models
|
|
);
|
|
|
|
$selected = array_filter($selected);
|
|
|
|
$field['html_attr']['data-selected'] = wp_json_encode($selected);
|
|
}
|
|
}
|
|
|
|
if ( ! is_null($value)) {
|
|
$field['value'] = $value;
|
|
}
|
|
|
|
$field['html_attr'] = $this->get_editor_fields_html_attr($field['html_attr'], $field['type']);
|
|
|
|
/**
|
|
* Default v-show
|
|
*/
|
|
$show_reqs = false;
|
|
|
|
if (isset($field['wrapper_html_attr'])) {
|
|
$show_reqs = wu_get_isset($field['wrapper_html_attr'], 'v-show');
|
|
}
|
|
|
|
$tab = wu_get_isset($field, 'tab', 'content');
|
|
|
|
$field['wrapper_html_attr'] = array_merge(
|
|
wu_get_isset($field, 'wrapper_html_attr', []),
|
|
[
|
|
'v-cloak' => 1,
|
|
'v-show' => sprintf('require("type", "%s") && require("tab", "%s")', $this->get_type(), $tab) . ($show_reqs ? " && $show_reqs" : ''),
|
|
]
|
|
);
|
|
}
|
|
|
|
return $final_field_list;
|
|
}
|
|
|
|
/**
|
|
* Returns a list of all the attributes.
|
|
*
|
|
* @since 2.0.0
|
|
* @return array
|
|
*/
|
|
public function get_all_attributes() {
|
|
|
|
$styles = [
|
|
'wrapper_element_classes',
|
|
'element_classes',
|
|
'element_id',
|
|
'from_request',
|
|
'width',
|
|
'logged',
|
|
];
|
|
|
|
$field_keys = array_keys($this->get_fields());
|
|
|
|
return array_merge($this->default_fields(), $field_keys, $styles);
|
|
}
|
|
|
|
/**
|
|
* Treat the attributes array to avoid reaching the input var limits.
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @param array $attributes The attributes.
|
|
* @return array
|
|
*/
|
|
public function reduce_attributes($attributes) {
|
|
|
|
return $attributes;
|
|
}
|
|
|
|
/**
|
|
* List of all the default fields available.
|
|
*
|
|
* @since 2.0.0
|
|
* @return array
|
|
*/
|
|
public static function fields_list() {
|
|
|
|
$fields = [];
|
|
|
|
$fields['id'] = [
|
|
'type' => 'text',
|
|
'title' => __('Field ID', 'wp-multisite-waas'),
|
|
'placeholder' => __('e.g. info-name', 'wp-multisite-waas'),
|
|
'tooltip' => __('Only alpha-numeric and hyphens allowed.', 'wp-multisite-waas'),
|
|
'desc' => __('The ID of the field. This is used to reference the field.', 'wp-multisite-waas'),
|
|
'value' => wu_request('id', ''),
|
|
'html_attr' => [
|
|
'v-on:input' => 'id = $event.target.value.toLowerCase().replace(/[^a-z0-9-_]+/g, "")',
|
|
'v-bind:value' => 'id',
|
|
],
|
|
];
|
|
|
|
$fields['name'] = [
|
|
'type' => 'text',
|
|
'title' => __('Field Label', 'wp-multisite-waas'),
|
|
'placeholder' => __('e.g. Your Name', 'wp-multisite-waas'),
|
|
'desc' => __('This is what your customer see as the field title.', 'wp-multisite-waas'),
|
|
'tooltip' => __('Leave blank to hide the field label. You can also set a placeholder value and tip in the "Additional Settings" tab.', 'wp-multisite-waas'),
|
|
'value' => '',
|
|
'html_attr' => [
|
|
'v-model' => 'name',
|
|
],
|
|
];
|
|
|
|
$fields['placeholder'] = [
|
|
'type' => 'text',
|
|
'title' => __('Field Placeholder', 'wp-multisite-waas'),
|
|
'placeholder' => __('e.g. Placeholder value', 'wp-multisite-waas'),
|
|
'desc' => __('This value appears inside the field, as an example of how to fill it.', 'wp-multisite-waas'),
|
|
'tooltip' => '',
|
|
'value' => '',
|
|
'tab' => 'advanced',
|
|
'html_attr' => [
|
|
'v-model' => 'placeholder',
|
|
],
|
|
];
|
|
|
|
$fields['tooltip'] = [
|
|
'type' => 'textarea',
|
|
'title' => __('Field Tooltip', 'wp-multisite-waas'),
|
|
'placeholder' => __('e.g. This field is great, be sure to fill it.', 'wp-multisite-waas'),
|
|
// translators: %is is the icon for a question mark.
|
|
'desc' => sprintf(__('Any text entered here will be shown when the customer hovers the %s icon next to the field label.', 'wp-multisite-waas'), wu_tooltip(__('Just like this!', 'wp-multisite-waas'))),
|
|
'tooltip' => '',
|
|
'value' => '',
|
|
'tab' => 'advanced',
|
|
'html_attr' => [
|
|
'v-model' => 'tooltip',
|
|
'rows' => 4,
|
|
],
|
|
];
|
|
|
|
$fields['default_value'] = [
|
|
'type' => 'text',
|
|
'title' => __('Default Value', 'wp-multisite-waas'),
|
|
'placeholder' => __('e.g. None', 'wp-multisite-waas'),
|
|
'value' => '',
|
|
'html_attr' => [
|
|
'v-model' => 'default_value',
|
|
],
|
|
];
|
|
|
|
$fields['note'] = [
|
|
'type' => 'textarea',
|
|
'title' => __('Content', 'wp-multisite-waas'),
|
|
'placeholder' => '',
|
|
'tooltip' => '',
|
|
'value' => '',
|
|
'html_attr' => [
|
|
'v-model' => 'content',
|
|
],
|
|
];
|
|
|
|
$fields['limits'] = [
|
|
'type' => 'group',
|
|
'title' => __('Field Length', 'wp-multisite-waas'),
|
|
'tooltip' => '',
|
|
'fields' => [
|
|
'min' => [
|
|
'type' => 'number',
|
|
'value' => '',
|
|
'placeholder' => __('Min', 'wp-multisite-waas'),
|
|
'wrapper_classes' => 'wu-w-1/2',
|
|
'html_attr' => [
|
|
'v-model' => 'min',
|
|
],
|
|
],
|
|
'max' => [
|
|
'type' => 'number',
|
|
'value' => '',
|
|
'placeholder' => __('Max', 'wp-multisite-waas'),
|
|
'wrapper_classes' => 'wu-ml-2 wu-w-1/2',
|
|
'html_attr' => [
|
|
'v-model' => 'max',
|
|
],
|
|
],
|
|
],
|
|
];
|
|
|
|
$fields['save_as'] = [
|
|
'type' => 'select',
|
|
'title' => __('Save As', 'wp-multisite-waas'),
|
|
'desc' => __('Select how you want to save this piece of meta data. You can attach it to the customer or the site as site meta or as site option.', 'wp-multisite-waas'),
|
|
'placeholder' => '',
|
|
'tooltip' => '',
|
|
'value' => 'customer_meta',
|
|
'order' => 99.5,
|
|
'options' => [
|
|
'customer_meta' => __('Customer Meta', 'wp-multisite-waas'),
|
|
'user_meta' => __('User Meta', 'wp-multisite-waas'),
|
|
'site_meta' => __('Site Meta', 'wp-multisite-waas'),
|
|
'site_option' => __('Site Option', 'wp-multisite-waas'),
|
|
'nothing' => __('Do not save', 'wp-multisite-waas'),
|
|
],
|
|
'html_attr' => [
|
|
'v-model' => 'save_as',
|
|
],
|
|
];
|
|
|
|
$fields['required'] = [
|
|
'type' => 'toggle',
|
|
'title' => __('Required', 'wp-multisite-waas'),
|
|
'desc' => __('Mark this field as required. The checkout will not proceed unless this field is filled.', 'wp-multisite-waas'),
|
|
'value' => 0,
|
|
'order' => 98,
|
|
'html_attr' => [
|
|
'v-model' => 'required',
|
|
],
|
|
];
|
|
|
|
return $fields;
|
|
}
|
|
}
|