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