/
class-configuration-storage.php
206 lines (171 loc) · 4.64 KB
/
class-configuration-storage.php
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<?php
/**
* WPSEO plugin file.
*
* @package WPSEO\Admin\ConfigurationUI
*/
/**
* Class WPSEO_Configuration_Storage.
*/
class WPSEO_Configuration_Storage {
/**
* Holds the configuration options adapter.
*
* @var \WPSEO_Configuration_Options_Adapter
*/
protected $adapter;
/**
* Holds the configuration fields.
*
* @var \WPSEO_Config_Field[]
*/
protected $fields = array();
/**
* Add default fields.
*/
public function add_default_fields() {
$fields = array(
new WPSEO_Config_Field_Upsell_Configuration_Service(),
new WPSEO_Config_Field_Upsell_Site_Review(),
new WPSEO_Config_Field_Success_Message(),
new WPSEO_Config_Field_Mailchimp_Signup(),
new WPSEO_Config_Field_Environment(),
new WPSEO_Config_Field_Site_Type(),
new WPSEO_Config_Field_Multiple_Authors(),
new WPSEO_Config_Field_Title_Intro(),
new WPSEO_Config_Field_Site_Name(),
new WPSEO_Config_Field_Separator(),
new WPSEO_Config_Field_Google_Search_Console_Intro(),
new WPSEO_Config_Field_Profile_URL_Facebook(),
new WPSEO_Config_Field_Profile_URL_Twitter(),
new WPSEO_Config_Field_Profile_URL_Instagram(),
new WPSEO_Config_Field_Profile_URL_LinkedIn(),
new WPSEO_Config_Field_Profile_URL_MySpace(),
new WPSEO_Config_Field_Profile_URL_Pinterest(),
new WPSEO_Config_Field_Profile_URL_YouTube(),
new WPSEO_Config_Field_Profile_URL_Wikipedia(),
new WPSEO_Config_Field_Company_Or_Person(),
new WPSEO_Config_Field_Company_Info_Missing(),
new WPSEO_Config_Field_Company_Name(),
new WPSEO_Config_Field_Company_Logo(),
new WPSEO_Config_Field_Person(),
new WPSEO_Config_Field_Post_Type_Visibility(),
);
$post_type_factory = new WPSEO_Config_Factory_Post_Type();
$fields = array_merge( $fields, $post_type_factory->get_fields() );
foreach ( $fields as $field ) {
$this->add_field( $field );
}
}
/**
* Allow for field injections.
*
* @param WPSEO_Config_Field $field Field to add to the stack.
*/
public function add_field( WPSEO_Config_Field $field ) {
$this->fields[] = $field;
if ( isset( $this->adapter ) ) {
$field->set_adapter( $this->adapter );
}
}
/**
* Set the adapter to use.
*
* @param WPSEO_Configuration_Options_Adapter $adapter Adapter to use.
*/
public function set_adapter( WPSEO_Configuration_Options_Adapter $adapter ) {
$this->adapter = $adapter;
foreach ( $this->fields as $field ) {
$field->set_adapter( $this->adapter );
}
}
/**
* Retrieve the current adapter.
*
* @return WPSEO_Configuration_Options_Adapter
*/
public function get_adapter() {
return $this->adapter;
}
/**
* Retrieve the registered fields.
*
* @returns array List of settings.
*/
public function retrieve() {
$output = array();
foreach ( $this->fields as $field ) {
$build = $field->to_array();
$data = $this->get_field_data( $field );
if ( ! is_null( $data ) ) {
$build['data'] = $data;
}
$output[ $field->get_identifier() ] = $build;
}
return $output;
}
/**
* Save the data.
*
* @param array $data_to_store Data provided by the API which needs to be processed for saving.
*
* @return string Results
*/
public function store( $data_to_store ) {
$output = array();
foreach ( $this->fields as $field ) {
$field_identifier = $field->get_identifier();
if ( ! array_key_exists( $field_identifier, $data_to_store ) ) {
continue;
}
$field_data = array();
if ( isset( $data_to_store[ $field_identifier ] ) ) {
$field_data = $data_to_store[ $field_identifier ];
}
$result = $this->adapter->set( $field, $field_data );
$build = array(
'result' => $result,
);
// Set current data to object to be displayed.
$data = $this->get_field_data( $field );
if ( ! is_null( $data ) ) {
$build['data'] = $data;
}
$output[ $field_identifier ] = $build;
}
return $output;
}
/**
* Filter out null input values.
*
* @param mixed $input Input to test against.
*
* @return bool
*/
protected function is_not_null( $input ) {
return ! is_null( $input );
}
/**
* Get data from a specific field.
*
* @param WPSEO_Config_Field $field Field to get data for.
*
* @return array|mixed
*/
protected function get_field_data( WPSEO_Config_Field $field ) {
$data = $this->adapter->get( $field );
if ( is_array( $data ) ) {
$defaults = $field->get_data();
// Remove 'null' values from input.
$data = array_filter( $data, array( $this, 'is_not_null' ) );
// Merge defaults with data.
$data = array_merge( $defaults, $data );
}
if ( is_null( $data ) ) {
// Get default if no data was set.
$data = $field->get_data();
return $data;
}
return $data;
}
}