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
|
<?php
namespace PostTypes;
/**
* A Metabox in ACF is called a "Field Group" or just "Group".
* So all instances of "Metabox" or "Box" can be understood as an "ACF Field Group"
*
* @see https://github.com/AdvancedCustomFields/acf
*/
class Metabox
{
/**
* The Box's key
*/
public string $key;
/**
* The Box's title
* they $key is derived from that
*/
public string $title;
/**
* ACF location rule groups
*/
public array $locations = [];
/**
* The Box's fields to add
*
* @var MetaboxField[]
*/
public array $fields = [];
/**
* The "ACF Group Settings"
* @see https://www.advancedcustomfields.com/resources/register-fields-via-php/#group-settings
*/
public array $options = [];
/**
* Metabox constructor.
*
* @param string $title
* @param array $options
*/
public function __construct(string $title, array $options = [])
{
// @see https://github.com/AdvancedCustomFields/acf/blob/5.9.3/includes/local-fields.php#L163
$this->key = 'group_' . str_replace(['_', '-', '/', ' '], '_', strtolower($title));
$this->title = $title;
$this->options($options);
}
/**
* Assign a PostType to add the Metabox to
*
* @param string|array $posttypes
*
* @return $this
*/
public function posttype($posttypes)
{
$posttypes = (array)$posttypes;
foreach ($posttypes as $posttype) {
$this->location('post_type', $posttype);
}
return $this;
}
/**
* Assign a Taxonomy to add the Metabox to
*
* @param string|array $taxonomies
*
* @return $this
*/
public function taxonomy($taxonomies)
{
$taxonomies = (array)$taxonomies;
foreach ($taxonomies as $taxonomy) {
$this->location('taxonomy', $taxonomy);
}
return $this;
}
/**
* Add a rule group to the acf group location
*
* @param string $param The type to check against
* @param string $value The value to check against
* @param string $operator The operator to check with
*
* @return $this
*/
public function location(string $param, string $value, string $operator = '==')
{
$this->locations[] = compact('param', 'operator', 'value');
return $this;
}
/**
* @param MetaboxField|array $fields
*
* @return $this
*/
public function field($fields)
{
if ($fields instanceof MetaboxField) {
$fields = [$fields];
}
foreach ($fields as &$field) {
// set the field's parent
$field->parent($this->key);
$this->fields[$field->key] = &$field;
}
return $this;
}
/**
* @param array $options
*
* @return $this
*/
public function options(array $options)
{
$this->options = $options;
return $this;
}
/**
* Add the acf local field group
*/
public function add()
{
// build the location rule groups
$ruleGroups = array_map(function ($location) {
return [$location];
}, $this->locations);
// merge with extra options
$fieldGroup = array_replace_recursive([
'key' => $this->key,
'title' => $this->title,
'location' => $ruleGroups,
], $this->options);
// add field group
acf_add_local_field_group($fieldGroup);
// add fields
foreach ($this->fields as $field) {
$field->add();
}
}
}
|
