1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
<?php
/**
* WPSEO plugin file.
*
* @package WPSEO\Admin
*/
/**
* Generate the HTML for a form fieldset to wrap grouped form elements.
*/
class Yoast_Form_Fieldset implements Yoast_Form_Element {
/**
* The fieldset ID.
*
* @var string
*/
private $id;
/**
* The fieldset HTML default attributes.
*
* @var array
*/
private $attributes = array(
'class' => 'yoast-form-fieldset',
);
/**
* The grouped form elements for the fieldset.
*
* @var string
*/
private $content;
/**
* The fieldset legend HTML default attributes.
*
* @var array
*/
private $legend_attributes = array(
'class' => 'yoast-form-legend',
);
/**
* A translatable string for the fieldset legend content.
*
* @var string
*/
private $legend_content;
/**
* Constructor.
*
* @param string $id ID for the fieldset.
* @param string $legend_content The translatable legend text.
* @param string $content The grouped form elements for the fieldset.
*/
public function __construct( $id, $legend_content, $content ) {
$this->id = $id;
$this->legend_content = $legend_content;
$this->content = $content;
}
/**
* Render the view.
*/
public function render_view() {
/*
* Extract because we want values accessible via variables for later use
* in the view instead of accessing them as an array.
*/
extract( $this->get_parts() );
require WPSEO_PATH . 'admin/views/form/fieldset.php';
}
/**
* Start output buffering to catch the form elements to wrap in the fieldset.
*/
public function start() {
ob_start();
}
/**
* Return output buffering with the form elements to wrap in the fieldset.
*/
public function end() {
$this->content = ob_get_clean();
}
/**
* Return the rendered view.
*
* @return string
*/
public function get_html() {
ob_start();
$this->render_view();
return ob_get_clean();
}
/**
* Output the rendered view.
*/
public function html() {
echo $this->get_html();
}
/**
* Add attributes to the fieldset default attributes.
*
* @param array $attributes Array of attributes names and values to merge with the defaults.
*/
public function add_attributes( $attributes ) {
$this->attributes = wp_parse_args( $attributes, $this->attributes );
}
/**
* Add attributes to the fieldset legend default attributes.
*
* @param array $attributes Array of attributes names and values to merge with the defaults.
*/
public function legend_add_attributes( $attributes ) {
$this->legend_attributes = wp_parse_args( $attributes, $this->legend_attributes );
}
/**
* Visually hide the fieldset legend but keep it available to assistive technologies.
*/
public function legend_hide() {
$this->legend_attributes = wp_parse_args(
array( 'class' => 'screen-reader-text' ),
$this->legend_attributes
);
}
/**
* Return the set of attributes and content for the fieldset.
*
* @return array
*/
private function get_parts() {
return array(
'id' => $this->id,
'attributes' => $this->get_attributes_html( $this->attributes ),
'legend_content' => $this->legend_content,
'legend_attributes' => $this->get_attributes_html( $this->legend_attributes ),
'content' => $this->content,
);
}
/**
* Return HTML formatted attributes as a string, when there are attributes set.
*
* @param array $attributes Fieldset or legend attributes.
*
* @return string A space separated list of HTML formatted attributes or empty string.
*/
private function get_attributes_html( $attributes ) {
if ( ! empty( $attributes ) ) {
array_walk( $attributes, array( $this, 'parse_attribute' ) );
// Use an initial space as `implode()` adds a space only between array elements.
return ' ' . implode( ' ', $attributes );
}
return '';
}
/**
* Escape and format an attribute as an HTML attribute.
*
* @param string $value The value of the attribute.
* @param string $attribute The attribute to look for.
*/
private function parse_attribute( & $value, $attribute ) {
$value = sprintf( '%s="%s"', esc_html( $attribute ), esc_attr( $value ) );
}
}
|