Files
wp-multisite-waas/inc/checkout/signup-fields/class-signup-field-select.php
2025-02-15 23:19:24 -07:00

265 lines
6.4 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;
use WP_Ultimo\Checkout\Signup_Fields\Base_Signup_Field;
// 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
*/
class Signup_Field_Select extends Base_Signup_Field {
/**
* Returns the type of the field.
*
* @since 2.0.0
* @return string
*/
public function get_type() {
return 'select';
}
/**
* Returns if this field should be present on the checkout flow or not.
*
* @since 2.0.0
* @return boolean
*/
public function is_required() {
return false;
}
/**
* Requires the title of the field/element type.
*
* This is used on the Field/Element selection screen.
*
* @since 2.0.0
* @return string
*/
public function get_title() {
return __('Select', 'wp-multisite-waas');
}
/**
* Returns the description of the field/element.
*
* This is used as the title attribute of the selector.
*
* @since 2.0.0
* @return string
*/
public function get_description() {
return __('Adds a select field.', 'wp-multisite-waas');
}
/**
* Returns the tooltip of the field/element.
*
* This is used as the tooltip attribute of the selector.
*
* @since 2.0.0
* @return string
*/
public function get_tooltip() {
return __('Adds a select field.', 'wp-multisite-waas');
}
/**
* 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
*/
public function get_icon() {
return 'dashicons-wu-list1';
}
/**
* Returns the default values for the field-elements.
*
* This is passed through a wp_parse_args before we send the values
* to the method that returns the actual fields for the checkout form.
*
* @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',
'default_value',
'tooltip',
'required',
'save_as',
];
}
/**
* 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 [];
}
/**
* Returns the list of additional fields specific to this type.
*
* @since 2.0.0
* @return array
*/
public function get_fields() {
$editor_fields = [];
$editor_fields['options_header'] = [
'order' => 12,
'type' => 'small-header',
'title' => __('Options', 'wp-multisite-waas'),
'desc' => __('Add different options below. The first option is used as the default.', 'wp-multisite-waas'),
];
$editor_fields['options_empty'] = [
'type' => 'note',
'desc' => __('Add the first option using the button below.', 'wp-multisite-waas'),
'classes' => 'wu-text-gray-600 wu-text-xs wu-text-center wu-w-full',
'wrapper_classes' => 'wu-bg-gray-100 wu-items-end',
'order' => 13,
'wrapper_html_attr' => [
'v-if' => 'options.length === 0',
'v-cloak' => '1',
],
];
$editor_fields['options'] = [
'order' => 14,
'type' => 'group',
'tooltip' => '',
'wrapper_classes' => 'wu-relative wu-bg-gray-100',
'wrapper_html_attr' => [
'v-if' => 'options.length',
'v-for' => '(option, index) in options',
'v-cloak' => '1',
],
'fields' => [
'options_remove' => [
'type' => 'note',
'desc' => sprintf('<a title="%s" class="wu-no-underline wu-inline-block wu-text-gray-600 wu-mt-2 wu-mr-2" href="#" @click.prevent="() => options.splice(index, 1)"><span class="dashicons-wu-squared-cross"></span></a>', __('Remove', 'wp-multisite-waas')),
'wrapper_classes' => 'wu-absolute wu-top-0 wu-right-0',
],
'options_key' => [
'type' => 'text',
'title' => __('Option Value', 'wp-multisite-waas'),
'placeholder' => __('e.g. option1', 'wp-multisite-waas'),
'wrapper_classes' => 'wu-w-1/2 wu-mr-2',
'html_attr' => [
'v-model' => 'option.key',
'steps' => 1,
'v-bind:name' => '"options[" + index + "][key]"',
],
],
'options_label' => [
'type' => 'text',
'title' => __('Label', 'wp-multisite-waas'),
'placeholder' => __('e.g. Option 1', 'wp-multisite-waas'),
'wrapper_classes' => 'wu-w-1/2 wu-ml-2',
'html_attr' => [
'v-model' => 'option.label',
'v-bind:name' => '"options[" + index + "][label]"',
],
],
],
];
$editor_fields['repeat_select_option'] = [
'order' => 16,
'type' => 'submit',
'title' => __('+ Add option', 'wp-multisite-waas'),
'classes' => 'wu-uppercase wu-text-2xs wu-text-blue-700 wu-border-none wu-bg-transparent wu-font-bold wu-text-right wu-w-full wu-cursor-pointer',
'wrapper_classes' => 'wu-bg-gray-100 wu-items-end',
'wrapper_html_attr' => [
'v-cloak' => '1',
],
'html_attr' => [
'type' => 'button',
'v-on:click.prevent' => '() => options.push({})',
],
];
return $editor_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.
*/
public function to_fields_array($attributes) {
$options = [];
foreach ($attributes['options'] as $_option) {
$options[ $_option['key'] ] = $_option['label'];
}
return [
$attributes['id'] => [
'type' => 'select',
'id' => $attributes['id'],
'name' => $attributes['name'],
'placeholder' => $attributes['placeholder'],
'tooltip' => $attributes['tooltip'],
'default' => $attributes['default_value'],
'required' => $attributes['required'],
'wrapper_classes' => $attributes['element_classes'],
'options' => $options,
'value' => $this->get_value(),
],
];
}
}