OrderWithdrawalFormView.php — WooCommerce 11.1.0

woocommerce / src / Internal / OrderWithdrawal / OrderWithdrawalFormView.php

woocommerce / src / Internal / OrderWithdrawal Last commit date

OrderWithdrawalController.php 2 weeks ago OrderWithdrawalFeatureHighlightNotification.php 2 weeks ago OrderWithdrawalFormProcessor.php 2 weeks ago OrderWithdrawalFormState.php 2 weeks ago OrderWithdrawalFormView.php 2 weeks ago

OrderWithdrawalFormView.php

210 lines

1	<?php
2	declare( strict_types = 1 );
3
4	namespace Automattic\WooCommerce\Internal\OrderWithdrawal;
5
6	/**
7	* Prepares order withdrawal template data.
8	*
9	* @internal Just for internal use.
10	*/
11	final class OrderWithdrawalFormView {
12
13	/**
14	* Get template arguments for the order withdrawal form.
15	*
16	* @param OrderWithdrawalFormState $state Processed form state.
17	* @param string $form_action_url Form action URL.
18	* @param string $shop_url Shop URL.
19	* @return array<string,mixed>
20	*
21	* @since 11.1.0
22	*/
23	public function get_template_args( OrderWithdrawalFormState $state, string $form_action_url, string $shop_url ): array {
24	return array(
25	'screen' => $state->screen,
26	'data' => $state->data,
27	'errors' => $state->errors,
28	'fields' => $this->get_prepared_form_fields( $state->errors ),
29	'withdrawal_type_options' => $this->get_withdrawal_type_options(),
30	'hidden_fields' => $this->get_hidden_fields( $state->data ),
31	'review_rows' => $this->get_review_rows( $state->data ),
32	'nonce_action' => OrderWithdrawalFormProcessor::NONCE_ACTION,
33	'nonce_field' => OrderWithdrawalFormProcessor::NONCE_FIELD,
34	'action_field' => OrderWithdrawalFormProcessor::ACTION_FIELD,
35	'action_review' => OrderWithdrawalFormProcessor::ACTION_REVIEW,
36	'action_confirm' => OrderWithdrawalFormProcessor::ACTION_CONFIRM,
37	'action_edit' => OrderWithdrawalFormProcessor::ACTION_EDIT,
38	'form_action_url' => $form_action_url,
39	'shop_url' => $shop_url,
40	);
41	}
42
43	/**
44	* Get form field definitions prepared for the template.
45	*
46	* @param array<string,string> $errors Validation errors keyed by field.
47	* @return array<string,array<string,mixed>>
48	*/
49	private function get_prepared_form_fields( array $errors ): array {
50	$fields = array();
51
52	foreach ( $this->get_form_field_schema() as $field_key => $field ) {
53	$field['name'] = OrderWithdrawalFormProcessor::get_field_name( $field_key );
54	$field['id'] = OrderWithdrawalFormProcessor::get_field_name( $field_key );
55	$field['input_class'] = array( 'woocommerce-Input', 'woocommerce-Input--' . (string) $field['type'] );
56
57	if ( isset( $errors[ $field_key ] ) ) {
58	$field['class'][] = 'woocommerce-invalid';
59	$field['custom_attributes']['aria-invalid'] = 'true';
60	$field['custom_attributes']['aria-errormessage'] = OrderWithdrawalFormProcessor::get_field_name( $field_key ) . '_error';
61	}
62
63	if ( OrderWithdrawalFormProcessor::FIELD_ADDITIONAL_DETAILS === $field_key ) {
64	$field['custom_attributes']['rows'] = '5';
65	}
66
67	$fields[ $field_key ] = $field;
68	}
69
70	return $fields;
71	}
72
73	/**
74	* Get hidden fields for review actions.
75	*
76	* @param array<string,string> $data Form data.
77	* @return array<int,array{name:string,value:string}>
78	*/
79	private function get_hidden_fields( array $data ): array {
80	$hidden_fields = array();
81
82	foreach ( $data as $field_key => $value ) {
83	$hidden_fields[] = array(
84	'name' => OrderWithdrawalFormProcessor::get_field_name( $field_key ),
85	'value' => $value,
86	);
87	}
88
89	return $hidden_fields;
90	}
91
92	/**
93	* Get rows for the review screen.
94	*
95	* @param array<string,string> $data Form data.
96	* @return array<int,array{label:string,value:string}>
97	*/
98	private function get_review_rows( array $data ): array {
99	return array(
100	array(
101	'label' => __( 'Name', 'woocommerce' ),
102	'value' => $this->get_customer_name( $data ),
103	),
104	array(
105	'label' => __( 'Email address', 'woocommerce' ),
106	'value' => $data[ OrderWithdrawalFormProcessor::FIELD_EMAIL ],
107	),
108	array(
109	'label' => __( 'Order number', 'woocommerce' ),
110	'value' => $data[ OrderWithdrawalFormProcessor::FIELD_ORDER_NUMBER ],
111	),
112	array(
113	'label' => __( 'Withdrawing', 'woocommerce' ),
114	'value' => $this->get_withdrawal_type_label( $data[ OrderWithdrawalFormProcessor::FIELD_WITHDRAWAL_TYPE ] ),
115	),
116	array(
117	'label' => __( 'Additional details', 'woocommerce' ),
118	'value' => '' === $data[ OrderWithdrawalFormProcessor::FIELD_ADDITIONAL_DETAILS ] ? __( 'None provided', 'woocommerce' ) : $data[ OrderWithdrawalFormProcessor::FIELD_ADDITIONAL_DETAILS ],
119	),
120	);
121	}
122
123	/**
124	* Get the form field definitions for the template.
125	*
126	* @return array<string,array<string,mixed>>
127	*/
128	private function get_form_field_schema(): array {
129	return array(
130	OrderWithdrawalFormProcessor::FIELD_FIRST_NAME => array(
131	'label' => __( 'First name', 'woocommerce' ),
132	'type' => 'text',
133	'class' => array( 'woocommerce-form-row', 'woocommerce-form-row--first', 'form-row-first' ),
134	'autocomplete' => 'given-name',
135	'required' => true,
136	),
137	OrderWithdrawalFormProcessor::FIELD_LAST_NAME => array(
138	'label' => __( 'Last name', 'woocommerce' ),
139	'type' => 'text',
140	'class' => array( 'woocommerce-form-row', 'woocommerce-form-row--last', 'form-row-last' ),
141	'autocomplete' => 'family-name',
142	'required' => true,
143	),
144	OrderWithdrawalFormProcessor::FIELD_EMAIL => array(
145	'label' => __( 'Email address', 'woocommerce' ),
146	'type' => 'email',
147	'class' => array( 'woocommerce-form-row', 'woocommerce-form-row--wide', 'form-row-wide' ),
148	'autocomplete' => 'email',
149	'required' => true,
150	),
151	OrderWithdrawalFormProcessor::FIELD_EMAIL_CONFIRMATION => array(
152	'label' => __( 'Confirm email address', 'woocommerce' ),
153	'type' => 'email',
154	'class' => array( 'woocommerce-form-row', 'woocommerce-form-row--wide', 'form-row-wide' ),
155	'autocomplete' => 'email',
156	'required' => true,
157	),
158	OrderWithdrawalFormProcessor::FIELD_ORDER_NUMBER => array(
159	'label' => __( 'Order number', 'woocommerce' ),
160	'type' => 'text',
161	'class' => array( 'woocommerce-form-row', 'woocommerce-form-row--wide', 'form-row-wide' ),
162	'required' => true,
163	),
164	OrderWithdrawalFormProcessor::FIELD_WITHDRAWAL_TYPE => array(
165	'label' => __( 'What do you want to withdraw?', 'woocommerce' ),
166	'type' => 'radio',
167	'required' => true,
168	),
169	OrderWithdrawalFormProcessor::FIELD_ADDITIONAL_DETAILS => array(
170	'label' => __( 'Additional details', 'woocommerce' ),
171	'type' => 'textarea',
172	'class' => array( 'woocommerce-form-row', 'woocommerce-form-row--wide', 'form-row-wide' ),
173	'required' => false,
174	),
175	);
176	}
177
178	/**
179	* Get the available withdrawal type options.
180	*
181	* @return array<string,string>
182	*/
183	private function get_withdrawal_type_options(): array {
184	return array(
185	OrderWithdrawalFormProcessor::WITHDRAWAL_TYPE_FULL => __( 'The full order', 'woocommerce' ),
186	OrderWithdrawalFormProcessor::WITHDRAWAL_TYPE_SPECIFIC => __( 'Specific items only', 'woocommerce' ),
187	);
188	}
189
190	/**
191	* Get the label for a withdrawal type value.
192	*
193	* @param string $withdrawal_type Withdrawal type value.
194	*/
195	private function get_withdrawal_type_label( string $withdrawal_type ): string {
196	$options = $this->get_withdrawal_type_options();
197
198	return $options[ $withdrawal_type ] ?? '';
199	}
200
201	/**
202	* Get the customer's full name for display.
203	*
204	* @param array<string,string> $data Form data.
205	*/
206	private function get_customer_name( array $data ): string {
207	return trim( $data[ OrderWithdrawalFormProcessor::FIELD_FIRST_NAME ] . ' ' . $data[ OrderWithdrawalFormProcessor::FIELD_LAST_NAME ] );
208	}
209	}
210