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
|
<?php
/**
* WPSEO plugin file.
*
* @package WPSEO\Admin
*/
/**
* Generates and displays the HTML for a metabox section.
*/
class WPSEO_Metabox_Tab_Section implements WPSEO_Metabox_Section {
/**
* @var WPSEO_Metabox_Tab[]
*/
public $tabs = array();
/**
* @var string
*/
public $name;
/**
* @var string
*/
private $link_content;
/**
* @var string
*/
private $link_title;
/**
* @var string
*/
private $link_class;
/**
* @var string
*/
private $link_aria_label;
/**
* Constructor.
*
* @param string $name The name of the section, used as an identifier in the html.
* Can only contain URL safe characters.
* @param string $link_content The text content of the section link.
* @param array $tabs The metabox tabs (`WPSEO_Metabox_Tabs[]`) to be included in the section.
* @param array $options Optional link attributes.
*/
public function __construct( $name, $link_content, array $tabs = array(), array $options = array() ) {
$default_options = array(
'link_title' => '',
'link_class' => '',
'link_aria_label' => '',
);
$options = array_merge( $default_options, $options );
$this->name = $name;
// Filter out invalid tab instances.
$valid_tabs = array_filter( $tabs, array( $this, 'is_valid_tab' ) );
foreach ( $valid_tabs as $tab ) {
$this->add_tab( $tab );
}
$this->link_content = $link_content;
$this->link_title = $options['link_title'];
$this->link_class = $options['link_class'];
$this->link_aria_label = $options['link_aria_label'];
}
/**
* Determines whether the passed tab is considered valid.
*
* @param mixed $tab The potential tab that needs to be validated.
*
* @return bool Whether or not the tab is valid.
*/
protected function is_valid_tab( $tab ) {
if ( $tab instanceof WPSEO_Metabox_Tab && ! $tab instanceof WPSEO_Metabox_Null_Tab ) {
return true;
}
return false;
}
/**
* Outputs the section link if any tab has been added.
*/
public function display_link() {
if ( $this->has_tabs() ) {
printf(
'<li role="tab"><a href="#wpseo-meta-section-%1$s" class="wpseo-meta-section-link %2$s"%3$s%4$s>%5$s</a></li>',
esc_attr( $this->name ),
esc_attr( $this->link_class ),
( '' !== $this->link_title ) ? ' title="' . esc_attr( $this->link_title ) . '"' : '',
( '' !== $this->link_aria_label ) ? ' aria-label="' . esc_attr( $this->link_aria_label ) . '"' : '',
$this->link_content
);
}
}
/**
* Outputs the section content if any tab has been added.
*/
public function display_content() {
if ( $this->has_tabs() ) {
$html = '<div id="%1$s" class="wpseo-meta-section">';
$html .= '<div class="wpseo-metabox-tabs-div">';
$html .= '<ul class="wpseo-metabox-tabs %2$s">%3$s</ul>%4$s';
$html .= '</div></div>';
printf(
$html,
esc_attr( 'wpseo-meta-section-' . $this->name ),
esc_attr( 'wpseo-metabox-tab-' . $this->name ),
$this->tab_links(),
$this->tab_content()
);
}
}
/**
* Add a `WPSEO_Metabox_Tab` object to the tabs.
*
* @param WPSEO_Metabox_Tab $tab Tab to add.
*/
public function add_tab( WPSEO_Metabox_Tab $tab ) {
$this->tabs[] = $tab;
}
/**
* Checks if any tabs have been added to the section.
*
* @return bool
*/
protected function has_tabs() {
return ! empty( $this->tabs );
}
/**
* Concatenates all tabs' links into one html string.
*
* @return string
*/
private function tab_links() {
$links = '';
foreach ( $this->tabs as $tab ) {
$links .= $tab->link();
}
return $links;
}
/**
* Concatenates all tabs' content into one html string.
*
* @return string
*/
private function tab_content() {
$content = '';
foreach ( $this->tabs as $tab ) {
$content .= $tab->content();
}
return $content;
}
/**
* Gets the name of the tab section.
*
* @return string The name of the tab section.
*/
public function get_name() {
return $this->name;
}
}
|