<?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_Checkbox extends Base_Signup_Field { /** * Returns the type of the field. * * @since 2.0.0 * @return string */ public function get_type() { return 'checkbox'; } /** * 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; } /** * Is this a user-related field? * * If this is set to true, this field will be hidden * when the user is already logged in. * * @since 2.0.0 * @return boolean */ public function is_user_field() { 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 __('Checkbox', 'wp-ultimo'); } /** * 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 checkout box that can be checked by the customer.', 'wp-ultimo'); } /** * 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 checkout box that can be checked by the customer.', 'wp-ultimo'); } /** * 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-check-square'; } /** * 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', 'tooltip', 'save_as', 'required', ]; } /** * 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() { return [ 'default_state' => [ 'type' => 'toggle', 'title' => __('Default State', 'wp-ultimo'), 'desc' => __('Use the toggle to the set the default state of the checkbox.', 'wp-ultimo'), 'value' => 0, 'order' => 12, ], ]; } /** * 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) { $checkout_fields = []; $checkout_fields[ $attributes['id'] ] = [ 'type' => 'checkbox', 'id' => $attributes['id'], 'name' => $attributes['name'], 'tooltip' => $attributes['tooltip'], 'required' => $attributes['required'], 'wrapper_classes' => $attributes['element_classes'], ]; if ($attributes['default_state']) { $checkout_fields[ $attributes['id'] ]['html_attr']['checked'] = 'checked'; } $value = $this->get_value(); if ('' !== $value && (bool) $value === true) { $checkout_fields[ $attributes['id'] ]['html_attr']['checked'] = 'checked'; } return $checkout_fields; } }