-
Notifications
You must be signed in to change notification settings - Fork 94
Expand file tree
/
Copy pathFont_Collection_Command.php
More file actions
415 lines (376 loc) · 10.2 KB
/
Font_Collection_Command.php
File metadata and controls
415 lines (376 loc) · 10.2 KB
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
<?php
use WP_CLI\Formatter;
/**
* Manages font collections.
*
* Font collections are predefined sets of fonts that can be used in WordPress.
* Collections are registered by WordPress core or themes and cannot be created
* or deleted via the command line.
*
* ## EXAMPLES
*
* # List all font collections
* $ wp font collection list
* +------------------+-------------------+---------+
* | slug | name | count |
* +------------------+-------------------+---------+
* | google-fonts | Google Fonts | 1500 |
* +------------------+-------------------+---------+
*
* # Get details about a specific font collection
* $ wp font collection get google-fonts
* +-------+------------------+
* | Field | Value |
* +-------+------------------+
* | slug | google-fonts |
* | name | Google Fonts |
* +-------+------------------+
*
* @package wp-cli
*
* @phpstan-type FontCategory array{name: string, slug: string}
* @phpstan-type FontFamily array{font_family_settings: array{name: string, slug: string, fontFamily: string, preview: string}, categories: string[]}
* @phpstan-type FontCollectionData array{name: string, font_families: FontFamily[], description: string, categories: FontCategory[]}
*/
class Font_Collection_Command extends WP_CLI_Command {
private $fields = [
'slug',
'name',
'description',
'categories',
];
/**
* Lists registered font collections.
*
* ## OPTIONS
*
* [--field=<field>]
* : Prints the value of a single field for each collection.
*
* [--fields=<fields>]
* : Limit the output to specific collection fields.
*
* [--format=<format>]
* : Render output in a particular format.
* ---
* default: table
* options:
* - table
* - csv
* - json
* - count
* - yaml
* ---
*
* ## AVAILABLE FIELDS
*
* These fields will be displayed by default for each collection:
*
* * slug
* * name
* * description
* * categories
*
* ## EXAMPLES
*
* # List all font collections
* $ wp font collection list
* +------------------+-------------------+
* | slug | name |
* +------------------+-------------------+
* | google-fonts | Google Fonts |
* +------------------+-------------------+
*
* # List collections in JSON format
* $ wp font collection list --format=json
* [{"slug":"google-fonts","name":"Google Fonts"}]
*
* @subcommand list
*/
public function list_( $args, $assoc_args ) {
$font_library = WP_Font_Library::get_instance();
$collections = $font_library->get_font_collections();
$items = [];
/**
* @var \WP_Font_Collection $collection
*/
foreach ( $collections as $collection ) {
$data = $collection->get_data();
if ( is_wp_error( $data ) ) {
WP_CLI::warning( $data );
continue;
}
$items[] = [
'slug' => $collection->slug,
'name' => $data['name'] ?? '',
'description' => $data['description'] ?? '',
'categories' => $this->format_categories( $data['categories'] ?? [] ),
];
}
$formatter = $this->get_formatter( $assoc_args );
$formatter->display_items( $items );
}
/**
* Gets details about a registered font collection.
*
* ## OPTIONS
*
* <slug>
* : Font collection slug.
*
* [--field=<field>]
* : Instead of returning the whole collection, returns the value of a single field.
*
* [--fields=<fields>]
* : Limit the output to specific fields. Defaults to all fields.
*
* [--format=<format>]
* : Render output in a particular format.
* ---
* default: table
* options:
* - table
* - csv
* - json
* - yaml
* ---
*
* ## AVAILABLE FIELDS
*
* These fields will be displayed by default for the specified collection:
*
* * slug
* * name
* * description
* * categories
*
* ## EXAMPLES
*
* # Get details of a specific collection
* $ wp font collection get google-fonts
* +-------+------------------+
* | Field | Value |
* +-------+------------------+
* | slug | google-fonts |
* | name | Google Fonts |
* +-------+------------------+
*
* # Get the name field only
* $ wp font collection get google-fonts --field=name
* Google Fonts
*/
public function get( $args, $assoc_args ) {
$slug = $args[0];
$font_library = WP_Font_Library::get_instance();
$collection = $font_library->get_font_collection( $slug );
if ( ! $collection ) {
WP_CLI::error( "Font collection {$slug} doesn't exist." );
}
$collection_data = $collection->get_data();
if ( is_wp_error( $collection_data ) ) {
WP_CLI::error( $collection_data );
}
$data = [
'slug' => $collection->slug,
'name' => $collection_data['name'] ?? '',
'description' => $collection_data['description'] ?? '',
'categories' => $this->format_categories( $collection_data['categories'] ?? [] ),
];
$formatter = $this->get_formatter( $assoc_args );
$formatter->display_item( $data );
}
/**
* Checks if a font collection is registered.
*
* ## OPTIONS
*
* <slug>
* : Font collection slug.
*
* ## EXAMPLES
*
* # Bash script for checking if a font collection is registered, with fallback.
*
* if wp font collection is-registered google-fonts 2>/dev/null; then
* # Font collection is registered. Do something.
* else
* # Fallback if collection is not registered.
* fi
*
* @subcommand is-registered
*
* @param string[] $args Positional arguments.
* @param array<string, mixed> $assoc_args Associative arguments.
*/
public function is_registered( $args, $assoc_args ) {
$slug = $args[0];
$font_library = WP_Font_Library::get_instance();
$collection = $font_library->get_font_collection( $slug );
if ( ! $collection ) {
WP_CLI::halt( 1 );
}
WP_CLI::halt( 0 );
}
/**
* Lists font families in a collection.
*
* ## OPTIONS
*
* <slug>
* : Font collection slug.
*
* [--category=<slug>]
* : Filter by category slug.
*
* [--field=<field>]
* : Prints the value of a single field for each family.
*
* [--fields=<fields>]
* : Limit the output to specific family fields.
*
* [--format=<format>]
* : Render output in a particular format.
* ---
* default: table
* options:
* - table
* - csv
* - json
* - count
* - yaml
* ---
*
* ## AVAILABLE FIELDS
*
* * slug
* * name
* * fontFamily
* * categories
* * preview
*
* ## EXAMPLES
*
* # List all font families in a collection
* $ wp font collection list-families google-fonts
*
* # List font families in a specific category
* $ wp font collection list-families google-fonts --category=sans-serif
*
* @subcommand list-families
*/
public function list_families( $args, $assoc_args ) {
$slug = $args[0];
$font_library = WP_Font_Library::get_instance();
$collection = $font_library->get_font_collection( $slug );
if ( ! $collection ) {
WP_CLI::error( "Font collection {$slug} doesn't exist." );
}
$collection_data = $collection->get_data();
if ( is_wp_error( $collection_data ) ) {
WP_CLI::error( $collection_data );
}
/**
* @var FontCollectionData $collection_data
*/
$font_families = $collection_data['font_families'] ?? [];
if ( empty( $font_families ) || ! is_array( $font_families ) ) {
WP_CLI::error( 'No font families found in this collection.' );
}
$category = \WP_CLI\Utils\get_flag_value( $assoc_args, 'category' );
$items = [];
foreach ( $font_families as $family ) {
$family_categories = $family['categories'] ?? [];
if ( $category && ! in_array( $category, $family_categories, true ) ) {
continue;
}
$settings = $family['font_family_settings'] ?? [];
$items[] = [
'slug' => $settings['slug'] ?? '',
'name' => $settings['name'] ?? '',
'fontFamily' => $settings['fontFamily'] ?? '',
'categories' => implode( ', ', $family_categories ),
'preview' => $settings['preview'] ?? '',
];
}
$fields = [ 'slug', 'name', 'fontFamily', 'categories', 'preview' ];
$formatter = new Formatter( $assoc_args, $fields, 'font-family' );
$formatter->display_items( $items );
}
/**
* Lists categories in a collection.
*
* ## OPTIONS
*
* <slug>
* : Font collection slug.
*
* [--field=<field>]
* : Prints the value of a single field for each category.
*
* [--fields=<fields>]
* : Limit the output to specific category fields.
*
* [--format=<format>]
* : Render output in a particular format.
* ---
* default: table
* options:
* - table
* - csv
* - json
* - count
* - yaml
* ---
*
* ## AVAILABLE FIELDS
*
* * slug
* * name
*
* ## EXAMPLES
*
* # List all categories in a collection
* $ wp font collection list-categories google-fonts
* +-------------+--------------+
* | slug | name |
* +-------------+--------------+
* | sans-serif | Sans Serif |
* | display | Display |
* +-------------+--------------+
*
* @subcommand list-categories
*/
public function list_categories( $args, $assoc_args ) {
$slug = $args[0];
$font_library = WP_Font_Library::get_instance();
$collection = $font_library->get_font_collection( $slug );
if ( ! $collection ) {
WP_CLI::error( "Font collection {$slug} doesn't exist." );
}
$collection_data = $collection->get_data();
if ( is_wp_error( $collection_data ) ) {
WP_CLI::error( $collection_data );
}
$categories = $collection_data['categories'] ?? null;
if ( empty( $categories ) || ! is_array( $categories ) ) {
WP_CLI::error( 'No categories found in this collection.' );
}
$fields = [ 'slug', 'name' ];
$formatter = new Formatter( $assoc_args, $fields, 'category' );
$formatter->display_items( $categories );
}
private function format_categories( array $categories ): string {
return implode(
', ',
array_map(
static function ( $category ) {
return "{$category['name']} ({$category['slug']})";
},
$categories
)
);
}
private function get_formatter( &$assoc_args ) {
return new Formatter( $assoc_args, $this->fields, 'font-collection' );
}
}