← All changes | classes/models/FrmTableHTMLGenerator.php +40 -182 6.28 → 5.0 View file →

		@@ -9,9 +9,8 @@
9	9	class FrmTableHTMLGenerator {
10	10
11	11	/**
12	12	* @var string
13		- *
14	13	* @since 2.04
15	14	*/
16	15	private $type = '';
17	16
		@@ -16,9 +15,8 @@
16	15	private $type = '';
17	16
18	17	/**
19	18	* @var array
20		- *
21	19	* @since 2.04
22	20	*/
23	21	private $style_settings = array();
24	22
		@@ -23,9 +21,8 @@
23	21	private $style_settings = array();
24	22
25	23	/**
26	24	* @var bool
27		- *
28	25	* @since 2.04
29	26	*/
30	27	private $use_inline_style = true;
31	28
		@@ -30,17 +27,14 @@
30	27	private $use_inline_style = true;
31	28
32	29	/**
33	30	* @var string
34		- *
35	31	* @since 2.04
36		- * @since 5.0.16 Changed scope from `private` to `protected`.
37	32	*/
38		- protected $direction = 'ltr';
	33	+ private $direction = 'ltr';
39	34
40	35	/**
41	36	* @var bool
42		- *
43	37	* @since 2.04
44	38	*/
45	39	private $odd = true;
46	40
		@@ -45,66 +39,27 @@
45	39	private $odd = true;
46	40
47	41	/**
48	42	* @var string
49		- *
50	43	* @since 2.04
51		- * @since 5.0.16 Changed scope from `private` to `protected`.
52	44	*/
53		- protected $table_style = '';
	45	+ private $table_style = '';
54	46
55	47	/**
56	48	* @var string
57		- *
58	49	* @since 2.04
59		- * @since 5.0.16 Changed scope from `private` to `protected`.
60	50	*/
61		- protected $td_style = '';
	51	+ private $td_style = '';
62	52
63	53	/**
64		- * Cell padding.
65		- *
66		- * @since 6.25
67		- *
68		- * @var string
69		- */
70		- protected $cell_padding = '7px 9px';
71		-
72		- /**
73		- * Table width.
74		- *
75		- * @since 6.25
76		- *
77		- * @var string
78		- */
79		- protected $width = '';
80		-
81		- /**
82		- * Used to add a class in tables. Set in Pro.
83		- *
84		- * @var bool
85		- *
86		- * @since 5.4.2
87		- */
88		- public $is_child = false;
89		-
90		- /**
91	54	* FrmTableHTMLGenerator constructor.
92	55	*
93	56	* @param string $type
94		- * @param array $atts
	57	+ * @param array $atts
95	58	*/
96	59	public function __construct( $type, $atts = array() ) {
97		- $this->type = $type;
98	60
99		- if ( isset( $atts['cell_padding'] ) ) {
100		- $this->cell_padding = $atts['cell_padding'];
101		- }
102		-
103		- if ( isset( $atts['width'] ) ) {
104		- $this->width = $atts['width'];
105		- }
106		-
	61	+ $this->type = (string) $type;
107	62	$this->init_style_settings( $atts );
108	63	$this->init_use_inline_style( $atts );
109	64	$this->init_direction( $atts );
110	65	$this->init_table_style();
		@@ -116,10 +71,8 @@
116	71	*
117	72	* @since 2.04
118	73	*
119	74	* @param array $atts
120		- *
121		- * @return void
122	75	*/
123	76	private function init_style_settings( $atts ) {
124	77	$style_settings = array(
125	78	'border_color' => 'dddddd',
		@@ -140,9 +93,9 @@
140	93	$this->style_settings[ $key ] = $this->get_color_markup( $this->style_settings[ $key ] );
141	94	}
142	95	}
143	96
144		- $this->style_settings['class'] = $atts['class'] ?? '';
	97	+ $this->style_settings['class'] = isset( $atts['class'] ) ? $atts['class'] : '';
145	98	}
146	99
147	100	/**
148	101	* Set the use_inline_style property
		@@ -149,10 +102,8 @@
149	102	*
150	103	* @since 2.04
151	104	*
152	105	* @param array $atts
153		- *
154		- * @return void
155	106	*/
156	107	private function init_use_inline_style( $atts ) {
157	108	if ( isset( $atts['inline_style'] ) && ! $atts['inline_style'] ) {
158	109	$this->use_inline_style = false;
		@@ -164,10 +115,8 @@
164	115	*
165	116	* @since 2.04
166	117	*
167	118	* @param array $atts
168		- *
169		- * @return void
170	119	*/
171	120	private function init_direction( $atts ) {
172	121	if ( isset( $atts['direction'] ) && $atts['direction'] === 'rtl' ) {
173	122	$this->direction = 'rtl';
		@@ -177,24 +126,20 @@
177	126	/**
178	127	* Set the table_style property
179	128	*
180	129	* @since 2.04
181		- *
182		- * @return void
183	130	*/
184	131	private function init_table_style() {
185	132	if ( $this->use_inline_style === true ) {
186		- $this->table_style = ' style="' . esc_attr( 'border-spacing:0;font-size:' . $this->style_settings['font_size'] . ';line-height:135%;' );
	133	+
	134	+ $this->table_style = ' style="' . esc_attr( 'font-size:' . $this->style_settings['font_size'] . ';line-height:135%;' );
187	135	$this->table_style .= esc_attr( 'border-bottom:' . $this->style_settings['border_width'] . ' solid ' . $this->style_settings['border_color'] . ';' ) . '"';
	136	+
188	137	}
189	138
190	139	if ( ! empty( $this->style_settings['class'] ) ) {
191	140	$this->table_style .= ' class="' . esc_attr( $this->style_settings['class'] ) . '"';
192	141	}
193		-
194		- if ( ! empty( $this->width ) ) {
195		- $this->table_style .= ' width="' . esc_attr( $this->width ) . '"';
196		- }
197	142	}
198	143
199	144	/**
200	145	* Set the td_style property
		@@ -199,70 +144,48 @@
199	144	/**
200	145	* Set the td_style property
201	146	*
202	147	* @since 2.04
203		- *
204		- * @return void
205	148	*/
206	149	private function init_td_style() {
207	150	if ( $this->use_inline_style === true ) {
208		- $td_style_attributes = 'text-align:' . ( $this->direction === 'rtl' ? 'right' : 'left' ) . ';';
209		- $td_style_attributes .= 'color:' . $this->style_settings['text_color'] . ';padding:' . $this->cell_padding . ';vertical-align:top;';
	151	+
	152	+ $td_style_attributes = 'text-align:' . ( $this->direction == 'rtl' ? 'right' : 'left' ) . ';';
	153	+ $td_style_attributes .= 'color:' . $this->style_settings['text_color'] . ';padding:7px 9px;vertical-align:top;';
210	154	$td_style_attributes .= 'border-top:' . $this->style_settings['border_width'] . ' solid ' . $this->style_settings['border_color'] . ';';
211	155
212		- $this->td_style = ' style="' . esc_attr( $td_style_attributes ) . '"';
	156	+ $this->td_style = ' style="' . $td_style_attributes . '"';
213	157	}
214	158	}
215	159
216	160	/**
217		- * Removes border CSS from HTML.
	161	+ * Determine if setting is for a color, e.g. text color, background color, or border color
218	162	*
219		- * @since 6.25
	163	+ * @param string $setting_key name of setting
220	164	*
221		- * @param string $html The HTML.
222		- * @param string $position The border position. Default is `top`.
223		- *
224		- * @return string
225		- */
226		- public function remove_border( $html, $position = 'top' ) {
227		- $search = sprintf(
228		- 'border-%1$s:%2$s solid %3$s;',
229		- $position,
230		- $this->style_settings['border_width'],
231		- $this->style_settings['border_color']
232		- );
233		-
234		- return str_replace( $search, '', $html );
235		- }
236		-
237		- /**
238		- * Determine if setting is for a color, e.g. text color, background color, or border color
239		- *
240	165	* @since 2.05
241	166	*
242		- * @param string $setting_key Name of setting.
243		- *
244		- * @return bool
	167	+ * @return boolean
245	168	*/
246	169	private function is_color_setting( $setting_key ) {
247		- return str_contains( $setting_key, 'color' );
	170	+ return strpos( $setting_key, 'color' ) !== false;
248	171	}
249	172
250	173	/**
251	174	* Get color markup from color setting value
252	175	*
	176	+ * @param string $color_markup value of a color setting, with format #FFFFF, FFFFFF, or white.
	177	+ *
253	178	* @since 2.05
254	179	*
255		- * @param string $color_markup value of a color setting, with format #FFFFF, FFFFFF, or white.
256		- *
257	180	* @return string
258	181	*/
259	182	private function get_color_markup( $color_markup ) {
260	183	$color_markup = trim( $color_markup );
261	184
262		- // Check if each character in string is valid hex digit
263		- if ( FrmAppHelper::ctype_xdigit( $color_markup ) ) {
264		- return '#' . $color_markup;
	185	+ //check if each character in string is valid hex digit
	186	+ if ( ctype_xdigit( $color_markup ) ) {
	187	+ $color_markup = '#' . $color_markup;
265	188	}
266	189
267	190	return $color_markup;
268	191	}
		@@ -274,9 +197,9 @@
274	197	*
275	198	* @return string
276	199	*/
277	200	private function table_row_background_color() {
278		- return $this->odd ? $this->style_settings['bg_color'] : $this->style_settings['alt_bg_color'];
	201	+ return ( $this->odd ? $this->style_settings['bg_color'] : $this->style_settings['alt_bg_color'] );
279	202	}
280	203
281	204	/**
282	205	* Get the table row style
		@@ -281,14 +204,13 @@
281	204	/**
282	205	* Get the table row style
283	206	*
284	207	* @since 2.04
285		- * @since 5.0.16 Changed scope from `private` to `protected`.
286		- * @since 6.25 Changed scope from `protected` to `public`.
287	208	*
288	209	* @return string
289	210	*/
290		- public function tr_style() {
	211	+ private function tr_style() {
	212	+
291	213	if ( $this->type === 'shortcode' ) {
292	214	$tr_style = ' style="[frm-alt-color]"';
293	215	} elseif ( $this->use_inline_style ) {
294	216	$tr_style = ' style="background-color:' . $this->table_row_background_color() . ';"';
		@@ -299,38 +221,13 @@
299	221	return $tr_style;
300	222	}
301	223
302	224	/**
303		- * Gets table style.
304		- *
305		- * @since 6.25
306		- *
307		- * @return string
308		- */
309		- public function get_table_style() {
310		- return $this->table_style;
311		- }
312		-
313		- /**
314		- * Gets td style.
315		- *
316		- * @since 6.25
317		- *
318		- * @return string
319		- */
320		- public function get_td_style() {
321		- return $this->td_style;
322		- }
323		-
324		- /**
325	225	* Switch the odd property from true to false or false to true
326	226	*
327	227	* @since 2.04
328		- * @since 5.0.16 Changed scope from `private` to `protected`.
329		- *
330		- * @return void
331	228	*/
332		- protected function switch_odd() {
	229	+ private function switch_odd() {
333	230	if ( $this->type !== 'shortcode' ) {
334	231	$this->odd = ! $this->odd;
335	232	}
336	233	}
		@@ -342,9 +239,9 @@
342	239	*
343	240	* @return string
344	241	*/
345	242	public function generate_table_header() {
346		- return '<table cellspacing="0"' . $this->table_style . '><tbody>' . "\r\n";
	243	+ return '<table cellspacing="0" ' . $this->table_style . '><tbody>' . "\r\n";
347	244	}
348	245
349	246	/**
350	247	* Generate a table footer
		@@ -361,22 +258,24 @@
361	258	* Generate a two cell row for an HTML table
362	259	*
363	260	* @since 2.04
364	261	*
365		- * @param string $label The label.
366		- * @param string $value The value.
367		- * @param array $args Additional arguments. May include "field_type" string.
	262	+ * @param string $label
	263	+ * @param string $value
368	264	*
369	265	* @return string
370	266	*/
371		- public function generate_two_cell_table_row( $label, $value, $args = array() ) {
372		- $row = '<tr' . $this->tr_style();
373		- $row .= $this->add_row_class( $value === '' );
374		- $row .= '>';
375		- $label = '<th scope="row"' . $this->td_style . '>' . wp_kses_post( $label ) . '</th>';
376		- $value = '<td' . $this->td_style . '>' . $this->filter_value_for_display( $value, $args ) . '</td>';
	267	+ public function generate_two_cell_table_row( $label, $value ) {
	268	+ $row = '<tr' . $this->tr_style();
	269	+ if ( $value === '' ) {
	270	+ $row .= ' class="frm-empty-row"';
	271	+ }
	272	+ $row .= '>';
377	273
378		- if ( 'rtl' === $this->direction ) {
	274	+ $label = '<th' . $this->td_style . '>' . wp_kses_post( $label ) . '</th>';
	275	+ $value = '<td' . $this->td_style . '>' . wp_kses_post( $value ) . '</td>';
	276	+
	277	+ if ( 'rtl' == $this->direction ) {
379	278	$row .= $value;
380	279	$row .= $label;
381	280	} else {
382	281	$row .= $label;
		@@ -390,23 +289,8 @@
390	289	return $row;
391	290	}
392	291
393	292	/**
394		- * @param string $value
395		- * @param array $args
396		- *
397		- * @return string
398		- */
399		- private function filter_value_for_display( $value, $args ) {
400		- if ( empty( $args['field_type'] ) ) {
401		- return wp_kses_post( $value );
402		- }
403		-
404		- $field_object = FrmFieldFactory::get_field_type( $args['field_type'] );
405		- return $field_object->filter_value_for_table_html( $value );
406		- }
407		-
408		- /**
409	293	* Generate a single cell row for an HTML table
410	294	*
411	295	* @since 2.04
412	296	*
		@@ -414,11 +298,9 @@
414	298	*
415	299	* @return string
416	300	*/
417	301	public function generate_single_cell_table_row( $value ) {
418		- $row = '<tr' . $this->tr_style();
419		- $row .= $this->add_row_class();
420		- $row .= '>';
	302	+ $row = '<tr' . $this->tr_style() . '>';
421	303	$row .= '<td colspan="2"' . $this->td_style . '>' . $value . '</td>';
422	304	$row .= '</tr>' . "\r\n";
423	305
424	306	$this->switch_odd();
		@@ -423,30 +305,6 @@
423	305
424	306	$this->switch_odd();
425	307
426	308	return $row;
427		- }
428		-
429		- /**
430		- * Add classes to the tr.
431		- *
432		- * @since 5.4.2
433		- *
434		- * @param bool $empty If the value in the row is blank.
435		- *
436		- * @return string
437		- */
438		- protected function add_row_class( $empty = false ) {
439		- $class = '';
440		-
441		- if ( $empty ) {
442		- // Only add this class on two cell rows.
443		- $class .= ' frm-empty-row';
444		- }
445		-
446		- if ( $this->is_child ) {
447		- $class .= ' frm-child-row';
448		- }
449		-
450		- return $class ? ' class="' . trim( $class ) . '"' : $class;
451	309	}
452	310	}