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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
<?php
/**
* Helper functions to work with multidimensional arrays easier.
*
* @since 1.5.6
*/
/**
* Determine whether the given value is array accessible.
*
* @since 1.5.6
*
* @param mixed $value Checkin to accessible.
*
* @return bool
*/
function wpforms_list_accessible( $value ) {
return is_array( $value ) || $value instanceof ArrayAccess;
}
/**
* Set an array item to a given value using "dot" notation.
*
* If no key is given to the method, the entire array will be replaced.
*
* @since 1.5.6
*
* @param array $array Existing array.
* @param string $key Path to set.
* @param mixed $value Value to set.
* @param string $separator Separator.
*
* @return array New array.
*/
function wpforms_list_set( $array, $key, $value, $separator = '.' ) {
if ( ! wpforms_list_accessible( $array ) ) {
return $value;
}
if ( is_null( $key ) ) {
$array = $value;
return $array;
}
$keys = explode( $separator, $key );
$count_keys = count( $keys );
$values = array_values( $keys );
$last_key = $values[ $count_keys - 1 ];
$tmp_array = &$array;
for ( $i = 0; $i < $count_keys - 1; $i ++ ) {
$k = $keys[ $i ];
$tmp_array = &$tmp_array[ $k ];
}
$tmp_array[ $last_key ] = $value;
return $array;
}
/**
* Determine if the given key exists in the provided array.
*
* @since 1.5.6
*
* @param \ArrayAccess|array $array Existing array.
* @param string|int $key To check.
*
* @return bool
*/
function wpforms_list_exists( $array, $key ) {
if ( ! wpforms_list_accessible( $array ) ) {
return false;
}
if ( $array instanceof ArrayAccess ) {
return $array->offsetExists( $key );
}
return array_key_exists( $key, $array );
}
/**
* Get an item from an array using "dot" notation.
*
* @since 1.5.6
*
* @param \ArrayAccess|array $array Where we want to get.
* @param string $key Key with dot's.
* @param mixed $default Value.
*
* @return mixed
*/
function wpforms_list_get( $array, $key, $default = null ) {
if ( ! wpforms_list_accessible( $array ) ) {
return $default;
}
if ( is_null( $key ) ) {
return $array;
}
if ( ! is_string( $key ) ) {
return $default;
}
if ( wpforms_list_exists( $array, $key ) ) {
return $array[ $key ];
}
foreach ( explode( '.', $key ) as $segment ) {
if ( wpforms_list_accessible( $array ) && wpforms_list_exists( $array, $segment ) ) {
$array = $array[ $segment ];
} else {
return $default;
}
}
return $array;
}
/**
* Check if an item exists in an array using "dot" notation.
*
* @since 1.5.6
*
* @param \ArrayAccess|array $array To check.
* @param string $key Keys with dot's.
*
* @return bool
*/
function wpforms_list_has( $array, $key ) {
if ( ! $array ) {
return false;
}
if ( is_null( $key ) || ! is_string( $key ) ) {
return false;
}
if ( wpforms_list_exists( $array, $key ) ) {
return true;
}
foreach ( explode( '.', $key ) as $segment ) {
if ( wpforms_list_accessible( $array ) && wpforms_list_exists( $array, $segment ) ) {
$array = $array[ $segment ];
} else {
return false;
}
}
return true;
}
/**
* Determine if an array is associative.
*
* An array is "associative" if it doesn't have sequential numerical keys beginning with zero.
*
* @since 1.5.6
*
* @param array $array To check.
*
* @return bool
*/
function wpforms_list_is_assoc( $array ) {
$keys = array_keys( $array );
return array_keys( $keys ) !== $keys;
}
/**
* Get a subset of the items from the given array.
*
* @since 1.5.6
*
* @param array $array To get.
* @param array|string $keys To filter.
*
* @return array
*/
function wpforms_list_only( $array, $keys ) {
return array_intersect_key( $array, array_flip( (array) $keys ) );
}
/**
* Remove one or many array items from a given array using "dot" notation.
*
* @since 1.5.6
*
* @param array $array To forget.
* @param array|string $keys To exclude.
*
* @return array
*/
function wpforms_list_forget( $array, $keys ) {
$tmp_array = &$array;
$keys = (array) $keys;
if ( count( $keys ) === 0 ) {
return $array;
}
foreach ( $keys as $key ) {
// if the exact key exists in the top-level, remove it.
if ( wpforms_list_exists( $array, $key ) ) {
unset( $array[ $key ] );
continue;
}
$parts = explode( '.', $key );
$count_keys = count( $parts );
$values = array_values( $parts );
$last_key = $values[ $count_keys - 1 ];
for ( $i = 0; $i < $count_keys - 1; $i ++ ) {
$k = $parts[ $i ];
$tmp_array = &$tmp_array[ $k ];
}
unset( $tmp_array[ $last_key ] );
}
return $array;
}
/**
* Insert a value or key/value pair after a specific key in an array.
* If key doesn't exist, value is appended to the end of the array.
*
* @since 1.5.8
*
* @param array $array Array where to insert.
* @param string $key Insert after key.
* @param array $new Array to insert.
*
* @return array
*/
function wpforms_list_insert_after( $array, $key, $new ) {
$keys = array_keys( $array );
$index = array_search( $key, $keys, true );
$pos = false === $index ? count( $array ) : $index + 1;
return array_merge( array_slice( $array, 0, $pos ), $new, array_slice( $array, $pos ) );
}
|