fluentform / app / Services / FormBuilder / Components / TabularGrid.php

TabularGrid.php in Fluent Forms – Customizable Contact Forms, Survey, Quiz, & Conversational Form Builder 6.2.9, at app/Services/FormBuilder/Components/TabularGrid.php

155 lines 6.2 KB

Raw Download Zip

1	<?php
2
3	namespace FluentForm\App\Services\FormBuilder\Components;
4
5	use FluentForm\Framework\Helpers\ArrayHelper;
6
7	class TabularGrid extends BaseComponent
8	{
9	/**
10	* Compile and echo the html element
11	*
12	* @param array $data [element data]
13	* @param \stdClass $form [Form Object]
14	*
15	* @return void
16	*/
17	public function compile($data, $form)
18	{
19	$elementName = $data['element'];
20	$data = apply_filters_deprecated(
21	'fluentform_rendering_field_data_' . $elementName,
22	[
23	$data,
24	$form
25	],
26	FLUENTFORM_FRAMEWORK_UPGRADE,
27	'fluentform/rendering_field_data_' . $elementName,
28	'Use fluentform/rendering_field_data_' . $elementName . ' instead of fluentform_rendering_field_data_' . $elementName
29	);
30	$data = apply_filters('fluentform/rendering_field_data_' . $elementName, $data, $form);
31
32	$checked = $data['settings']['selected_grids'];
33	$columnLabels = $data['settings']['grid_columns'];
34
35	$fieldType = $data['settings']['tabular_field_type'];
36	$columnHeaders = implode('</th><th>', array_values($columnLabels));
37	$elementHelpMessage = $this->getElementHelpMessage($data, $form);
38	$elementLabel = $this->setClasses($data)->buildElementLabel($data, $form);
39
40	$elMarkup = "<table class='ff-table ff-checkable-grids ff_flexible_table' role='table'><thead><tr><th></th><th>" . fluentform_sanitize_html($columnHeaders) . '</th></tr></thead><tbody>';
41
42	$tabIndex = \FluentForm\App\Helpers\Helper::getNextTabIndex();
43	foreach ($this->makeTabularData($data) as $index => $row) {
44	$elMarkup .= '<tr role="row"">';
45	$elMarkup .= "<td class='ff_grid_header' role='cell'>" . fluentform_sanitize_html($row['label']) . '</td>';
46	$isRowChecked = in_array($row['name'], $checked) ? 'checked' : '';
47	foreach ($row['columns'] as $column) {
48	$name = $data['attributes']['name'] . '[' . $row['name'] . ']';
49	$name = 'checkbox' == $fieldType ? ($name . '[]') : $name;
50	$isColChecked = in_array($column['name'], $checked) ? 'checked' : '';
51	$isChecked = $isRowChecked ? $isRowChecked : $isColChecked;
52
53	$atts = [
54	'name' => $name,
55	'type' => $fieldType,
56	'value' => $column['name'],
57	];
58	if ($tabIndex) {
59	$atts['tabindex'] = $tabIndex;
60	}
61	$attributes = $this->buildAttributes($atts, $form);
62
63	$ariaRequired = 'false';
64	if (ArrayHelper::get($data, 'settings.validation_rules.required.value')) {
65	$ariaRequired = 'true';
66	}
67
68	$input = '<input aria-label="'. $row['name'] .'-'. $column['label'] . '" ' . $attributes . " {$isChecked} aria-invalid='false' aria-required={$ariaRequired}>"; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- $attributes is escaped before being passed in.
69	$elMarkup .= "<td data-label='" . fluentform_sanitize_html($column['label']) . "'>{$input}</td>";
70	}
71	$elMarkup .= '</tr>';
72	}
73
74	$elMarkup .= '</tbody></table>';
75
76	$elMarkup = "<div class='ff-el-input--content'>{$elMarkup}" . fluentform_sanitize_html($elementHelpMessage) . '</div>';
77
78	$html = sprintf(
79	"<div data-type='%s' data-name='%s' class='%s'>%s",
80	$data['attributes']['data-type'],
81	$data['attributes']['name'],
82	$data['attributes']['class'],
83	$elementLabel
84	) . $elMarkup . '</div>'; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- $elementLabel is escaped before being passed in.
85
86	$html = apply_filters_deprecated(
87	'fluentform_rendering_field_html_' . $elementName,
88	[
89	$html,
90	$data,
91	$form
92	],
93	FLUENTFORM_FRAMEWORK_UPGRADE,
94	'fluentform/rendering_field_html_' . $elementName,
95	'Use fluentform/rendering_field_html_' . $elementName . ' instead of fluentform_rendering_field_html_' . $elementName
96	);
97	$this->printContent('fluentform/rendering_field_html_' . $elementName, $html, $data, $form);
98	}
99
100	public function makeTabularData($data)
101	{
102	$table = [];
103	$rows = $data['settings']['grid_rows'];
104	$columns = $data['settings']['grid_columns'];
105
106	foreach ($rows as $rowKey => $rowValue) {
107	$rowKey = trim(sanitize_text_field($rowKey));
108	$table[$rowKey] = [
109	'name' => $rowKey,
110	'label' => $rowValue,
111	'columns' => [],
112	];
113
114	foreach ($columns as $columnKey => $columnValue) {
115	$columnKey = trim(sanitize_text_field($columnKey));
116	$table[$rowKey]['columns'][] = [
117	'name' => $columnKey,
118	'label' => $columnValue,
119	];
120	}
121	}
122
123	return $table;
124	}
125
126	protected function getElementHelpMessage($data, $form)
127	{
128	$elementHelpMessage = '';
129	$helpMessagePlacement = ArrayHelper::get($form->settings, 'layout.helpMessagePlacement', 'with_label');
130	if ('under_input' == $helpMessagePlacement) {
131	$elementHelpMessage = $this->getInputHelpMessage($data);
132	}
133
134	return $elementHelpMessage;
135	}
136
137	protected function setClasses(&$data)
138	{
139	if (! isset($data['attributes']['class'])) {
140	$data['attributes']['class'] = '';
141	}
142
143	$placement = $data['settings']['label_placement'];
144	$placementClass = $placement ? 'ff-el-form-' . $placement : '';
145	$hasConditions = $this->hasConditions($data) ? ' has-conditions' : '';
146	$defaultContainerClass = $this->getDefaultContainerClass();
147	$containerClass = $data['settings']['container_class'];
148	$data['attributes']['class'] .= trim(implode(' ', array_map('trim', [
149	$defaultContainerClass, $containerClass, $placementClass, $hasConditions,
150	])));
151
152	return $this;
153	}
154	}
155