├── .gitignore
├── src
    ├── Exceptions
    │   ├── DuplicateKeyException.php
    │   └── InvalidFieldsException.php
    ├── Console
    │   ├── stubs
    │   │   ├── views
    │   │   │   ├── widget.stub
    │   │   │   └── block.stub
    │   │   ├── partial.stub
    │   │   ├── field.stub
    │   │   ├── options.stub
    │   │   ├── widget.stub
    │   │   ├── options.full.stub
    │   │   ├── block.stub
    │   │   └── block.localized.stub
    │   ├── FieldMakeCommand.php
    │   ├── PartialMakeCommand.php
    │   ├── ClearCommand.php
    │   ├── OptionsMakeCommand.php
    │   ├── WidgetMakeCommand.php
    │   ├── StubPublishCommand.php
    │   ├── IdeHelpersCommand.php
    │   ├── CacheCommand.php
    │   ├── UpgradeCommand.php
    │   ├── BlockMakeCommand.php
    │   ├── UsageCommand.php
    │   └── MakeCommand.php
    ├── Contracts
    │   ├── Composer.php
    │   ├── Block.php
    │   └── Widget.php
    ├── Concerns
    │   ├── HasCollection.php
    │   ├── InteractsWithBlade.php
    │   └── InteractsWithPartial.php
    ├── Partial.php
    ├── Builder
    │   ├── Concerns
    │   │   └── HasParentContext.php
    │   ├── ChoiceFieldBuilder.php
    │   ├── TabBuilder.php
    │   ├── AccordionBuilder.php
    │   ├── FieldBuilder.php
    │   ├── GroupBuilder.php
    │   ├── RepeaterBuilder.php
    │   └── FlexibleContentBuilder.php
    ├── Field.php
    ├── Providers
    │   └── AcfComposerServiceProvider.php
    ├── Manifest.php
    ├── Options.php
    ├── Widget.php
    ├── Composer.php
    ├── Builder.php
    ├── AcfComposer.php
    └── Block.php
├── resources
    └── views
    │   ├── alpine-support.blade.php
    │   ├── field-usage.blade.php
    │   └── block-editor-filters.blade.php
├── .editorconfig
├── composer.json
├── LICENSE.md
├── config
    └── acf.php
└── README.md


/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor
2 | composer.lock
3 | _ide-helpers.php
4 | 


--------------------------------------------------------------------------------
/src/Exceptions/DuplicateKeyException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Exceptions;
 4 | 
 5 | use Exception;
 6 | 
 7 | class DuplicateKeyException extends Exception
 8 | {
 9 |     //
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Console/stubs/views/widget.stub:
--------------------------------------------------------------------------------
1 | @if ($items)
2 |   <ul>
3 |     @foreach ($items as $item)
4 |       <li>{{ $item['item'] }}</li>
5 |     @endforeach
6 |   </ul>
7 | @else
8 |   <p>No items found!</p>
9 | @endif


--------------------------------------------------------------------------------
/resources/views/alpine-support.blade.php:
--------------------------------------------------------------------------------
1 | <script type="text/javascript">
2 |   acf.addFilter('acf_blocks_parse_node_attr', (current, node) => (node.name.startsWith('x-') || node.name.startsWith('@')) ? node : current);
3 | </script>
4 | 


--------------------------------------------------------------------------------
/src/Contracts/Composer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Contracts;
 4 | 
 5 | interface Composer
 6 | {
 7 |     /**
 8 |      * Compose the fields.
 9 |      *
10 |      * @return mixed
11 |      */
12 |     public function compose();
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Contracts/Block.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Contracts;
 4 | 
 5 | interface Block
 6 | {
 7 |     /**
 8 |      * Data to be passed to the rendered block view.
 9 |      *
10 |      * @return array
11 |      */
12 |     public function with();
13 | }
14 | 


--------------------------------------------------------------------------------
/resources/views/field-usage.blade.php:
--------------------------------------------------------------------------------
 1 | @props([
 2 |   'name',
 3 |   'label',
 4 |   'options' => '',
 5 |   'native' => null,
 6 | ])
 7 | 
 8 | @php($field = $native ? "{$native}('<fg=blue>{$label}</>'" : "addField('<fg=blue>{$name}</>', '<fg=blue>{$label}</>'")
 9 | 
10 | <fg=gray>$fields
11 |     ->{!! $field !!}, [
12 | {!! $options !!}
13 |     ]);</>
14 | 


--------------------------------------------------------------------------------
/src/Exceptions/InvalidFieldsException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Exceptions;
 4 | 
 5 | use Exception;
 6 | 
 7 | class InvalidFieldsException extends Exception
 8 | {
 9 |     /**
10 |      * The exception message.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $message = 'Fields must be an array or instance of Log1x\AcfComposer\Builder.';
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Contracts/Widget.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Contracts;
 4 | 
 5 | interface Widget
 6 | {
 7 |     /**
 8 |      * The widget title.
 9 |      *
10 |      * @return string
11 |      */
12 |     public function title();
13 | 
14 |     /**
15 |      * Data to be passed to the rendered widget view.
16 |      *
17 |      * @return array
18 |      */
19 |     public function with();
20 | }
21 | 


--------------------------------------------------------------------------------
/src/Concerns/HasCollection.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Concerns;
 4 | 
 5 | use Illuminate\Support\Collection;
 6 | 
 7 | trait HasCollection
 8 | {
 9 |     /**
10 |      * Initialize a Collection instance.
11 |      *
12 |      * @param  string[]  $value
13 |      * @return \Illuminate\Support\Collection
14 |      */
15 |     public function collect($value)
16 |     {
17 |         return Collection::make($value);
18 |     }
19 | }
20 | 


--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
 1 | root = true
 2 | 
 3 | [*]
 4 | charset = utf-8
 5 | end_of_line = lf
 6 | insert_final_newline = true
 7 | indent_style = space
 8 | indent_size = 2
 9 | trim_trailing_whitespace = true
10 | 
11 | [*.md]
12 | trim_trailing_whitespace = false
13 | 
14 | [*.php]
15 | indent_size = 4
16 | 
17 | [src/Console/stubs/*.stub]
18 | indent_size = 4
19 | 
20 | [src/Console/stubs/views/*.stub]
21 | indent_size = 2
22 | 
23 | [*.blade.php]
24 | indent_size = 2
25 | 


--------------------------------------------------------------------------------
/src/Console/stubs/views/block.stub:
--------------------------------------------------------------------------------
 1 | @unless ($block->preview)
 2 |   <div {{ $attributes }}>
 3 | @endunless
 4 | 
 5 | @if ($items)
 6 |   <ul>
 7 |     @foreach ($items as $item)
 8 |       <li>{{ $item['item'] }}</li>
 9 |     @endforeach
10 |   </ul>
11 | @else
12 |   <p>{{ $block->preview ? 'Add an item...' : 'No items found!' }}</p>
13 | @endif
14 | 
15 | <div>
16 |   <InnerBlocks template="{{ $block->template }}" />
17 | </div>
18 | 
19 | @unless ($block->preview)
20 |   </div>
21 | @endunless
22 | 


--------------------------------------------------------------------------------
/src/Console/stubs/partial.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DummyNamespace;
 4 | 
 5 | use Log1x\AcfComposer\Builder;
 6 | use Log1x\AcfComposer\Partial;
 7 | 
 8 | class DummyClass extends Partial
 9 | {
10 |     /**
11 |      * The partial field group.
12 |      */
13 |     public function fields(): Builder
14 |     {
15 |         $fields = Builder::make('DummySnake');
16 | 
17 |         $fields
18 |             ->addRepeater('items')
19 |                 ->addText('item')
20 |             ->endRepeater();
21 | 
22 |         return $fields;
23 |     }
24 | }
25 | 


--------------------------------------------------------------------------------
/src/Partial.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer;
 4 | 
 5 | abstract class Partial extends Composer
 6 | {
 7 |     /**
 8 |      * Compose and register the defined field groups with ACF.
 9 |      *
10 |      * @param  array  $args  Optional arguments to pass to the partial.
11 |      * @return \StoutLogic\AcfBuilder\FieldsBuilder|void
12 |      */
13 |     public function compose(array $args = [])
14 |     {
15 |         $fields = $this->resolveFields($args);
16 | 
17 |         if (blank($fields)) {
18 |             return;
19 |         }
20 | 
21 |         return $fields;
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Console/stubs/field.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DummyNamespace;
 4 | 
 5 | use Log1x\AcfComposer\Builder;
 6 | use Log1x\AcfComposer\Field;
 7 | 
 8 | class DummyClass extends Field
 9 | {
10 |     /**
11 |      * The field group.
12 |      */
13 |     public function fields(): array
14 |     {
15 |         $fields = Builder::make('DummySnake');
16 | 
17 |         $fields
18 |             ->setLocation('post_type', '==', 'post');
19 | 
20 |         $fields
21 |             ->addRepeater('items')
22 |                 ->addText('item')
23 |             ->endRepeater();
24 | 
25 |         return $fields->build();
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/resources/views/block-editor-filters.blade.php:
--------------------------------------------------------------------------------
 1 | @verbatim
 2 |   wp.hooks.addFilter(
 3 |     'blocks.getBlockDefaultClassName',
 4 |     'acf-composer/block-slug-classname',
 5 |     (className, blockName) => {
 6 |         if (! blockName.startsWith('acf/')) {
 7 |             return className;
 8 |         }
 9 | 
10 |         const list = (className || '').split(/\\s+/);
11 | 
12 |         const classes = list.reduce((acc, current) => {
13 |             acc.push(current);
14 | 
15 |             if (current.startsWith('wp-block-acf-')) {
16 |                 acc.push(
17 |                     current.replace('wp-block-acf-', 'wp-block-')
18 |                 );
19 |             }
20 | 
21 |             return acc;
22 |         }, []);
23 | 
24 |         return classes.join(' ');
25 |     }
26 |   );
27 | @endverbatim
28 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "log1x/acf-composer",
 3 |   "type": "package",
 4 |   "description": "Create fields, blocks, option pages, and widgets using ACF Builder and Sage 10",
 5 |   "license": "MIT",
 6 |   "authors": [
 7 |     {
 8 |       "name": "Brandon Nifong",
 9 |       "email": "brandon@tendency.me"
10 |     }
11 |   ],
12 |   "autoload": {
13 |     "psr-4": {
14 |       "Log1x\\AcfComposer\\": "src/"
15 |     }
16 |   },
17 |   "require": {
18 |     "php": "^8.0",
19 |     "stoutlogic/acf-builder": "^1.11",
20 |     "laravel/prompts": "*"
21 |   },
22 |   "require-dev": {
23 |     "laravel/pint": "^1.14",
24 |     "roots/acorn": "^3.0|^4.0"
25 |   },
26 |   "extra": {
27 |     "acorn": {
28 |       "providers": [
29 |         "Log1x\\AcfComposer\\Providers\\AcfComposerServiceProvider"
30 |       ]
31 |     }
32 |   }
33 | }
34 | 


--------------------------------------------------------------------------------
/src/Console/stubs/options.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DummyNamespace;
 4 | 
 5 | use Log1x\AcfComposer\Builder;
 6 | use Log1x\AcfComposer\Options as Field;
 7 | 
 8 | class DummyClass extends Field
 9 | {
10 |     /**
11 |      * The option page menu name.
12 |      *
13 |      * @var string
14 |      */
15 |     public $name = 'DummyTitle';
16 | 
17 |     /**
18 |      * The option page document title.
19 |      *
20 |      * @var string
21 |      */
22 |     public $title = 'DummyTitle | Options';
23 | 
24 |     /**
25 |      * The option page field group.
26 |      */
27 |     public function fields(): array
28 |     {
29 |         $fields = Builder::make('DummySnake');
30 | 
31 |         $fields
32 |             ->addRepeater('items')
33 |                 ->addText('item')
34 |             ->endRepeater();
35 | 
36 |         return $fields->build();
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/src/Concerns/InteractsWithBlade.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Concerns;
 4 | 
 5 | use Illuminate\Support\Str;
 6 | 
 7 | use function Roots\view;
 8 | 
 9 | trait InteractsWithBlade
10 | {
11 |     /**
12 |      * Render the specified view using Blade.
13 |      *
14 |      * @param  string  $view
15 |      * @param  array  $with
16 |      * @return string
17 |      */
18 |     public function view($view, $with = [])
19 |     {
20 |         if (
21 |             isset($this->block) &&
22 |             ! empty($this->preview)
23 |         ) {
24 |             $preview = Str::replaceLast(
25 |                 $name = Str::afterLast($view, '.'),
26 |                 Str::start($name, 'preview-'),
27 |                 $view
28 |             );
29 | 
30 |             $view = view()->exists($preview) ? $preview : $view;
31 |         }
32 | 
33 |         return view($view, $with, $this->with())->render();
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/src/Console/FieldMakeCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Console;
 4 | 
 5 | class FieldMakeCommand extends MakeCommand
 6 | {
 7 |     /**
 8 |      * The console command signature.
 9 |      *
10 |      * @var string
11 |      */
12 |     protected $signature = 'acf:field {name* : The name of the field group}
13 |                                       {--force : Overwrite any existing files}';
14 | 
15 |     /**
16 |      * The console command description.
17 |      *
18 |      * @var string
19 |      */
20 |     protected $description = 'Create a new ACF field group.';
21 | 
22 |     /**
23 |      * The type of class being generated.
24 |      *
25 |      * @var string
26 |      */
27 |     protected $type = 'Field';
28 | 
29 |     /**
30 |      * Get the stub file for the generator.
31 |      *
32 |      * @return string
33 |      */
34 |     protected function getStub()
35 |     {
36 |         return $this->resolveStub('field');
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/src/Console/PartialMakeCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Console;
 4 | 
 5 | class PartialMakeCommand extends MakeCommand
 6 | {
 7 |     /**
 8 |      * The console command signature.
 9 |      *
10 |      * @var string
11 |      */
12 |     protected $signature = 'acf:partial {name* : The name of the partial field group}
13 |                                         {--force : Overwrite any existing files}';
14 | 
15 |     /**
16 |      * The console command description.
17 |      *
18 |      * @var string
19 |      */
20 |     protected $description = 'Create a new ACF field group partial.';
21 | 
22 |     /**
23 |      * The type of class being generated.
24 |      *
25 |      * @var string
26 |      */
27 |     protected $type = 'Fields\\Partials';
28 | 
29 |     /**
30 |      * Get the stub file for the generator.
31 |      *
32 |      * @return string
33 |      */
34 |     protected function getStub()
35 |     {
36 |         return $this->resolveStub('partial');
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/src/Console/ClearCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Console;
 4 | 
 5 | use Illuminate\Console\Command;
 6 | use Log1x\AcfComposer\AcfComposer;
 7 | 
 8 | class ClearCommand extends Command
 9 | {
10 |     /**
11 |      * The name and signature of the console command.
12 |      *
13 |      * @var string
14 |      */
15 |     protected $signature = 'acf:clear';
16 | 
17 |     /**
18 |      * The console command description.
19 |      *
20 |      * @var string
21 |      */
22 |     protected $description = 'Clear the ACF Composer cache.';
23 | 
24 |     /**
25 |      * The ACF Composer instance.
26 |      */
27 |     protected AcfComposer $composer;
28 | 
29 |     /**
30 |      * Execute the console command.
31 |      */
32 |     public function handle()
33 |     {
34 |         $this->composer = $this->laravel['AcfComposer'];
35 | 
36 |         return $this->composer->manifest()->delete()
37 |             ? $this->components->info('Successfully cleared the <fg=blue>ACF Composer</> cache.')
38 |             : $this->components->info('The <fg=blue>ACF Composer</> cache is already cleared.');
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) Brandon Nifong
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/src/Builder/Concerns/HasParentContext.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Builder\Concerns;
 4 | 
 5 | trait HasParentContext
 6 | {
 7 |     /**
 8 |      * Handle dynamic method calls into the fields builder.
 9 |      *
10 |      * @param  string  $method
11 |      * @param  array  $args
12 |      * @return mixed
13 |      */
14 |     public function __call($method, $args)
15 |     {
16 |         if (
17 |             preg_match('/^add.+/', $method) &&
18 |             (method_exists($this->fieldsBuilder, $method) || $this->fieldsBuilder->getFieldType($method))
19 |         ) {
20 |             $field = $this->handleCall($method, $args);
21 |             $field->setParentContext($this);
22 | 
23 |             return $field;
24 |         }
25 | 
26 |         return parent::__call($method, $args);
27 |     }
28 | 
29 |     /**
30 |      * Hanlde the Fields Builder method call.
31 |      *
32 |      * @param  string  $method
33 |      * @param  array  $args
34 |      * @return mixed
35 |      */
36 |     protected function handleCall($method, $args)
37 |     {
38 |         return call_user_func_array([$this->fieldsBuilder, $method], $args);
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/src/Concerns/InteractsWithPartial.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Concerns;
 4 | 
 5 | use Illuminate\Support\Str;
 6 | use Log1x\AcfComposer\Partial;
 7 | use ReflectionClass;
 8 | use StoutLogic\AcfBuilder\FieldsBuilder;
 9 | 
10 | trait InteractsWithPartial
11 | {
12 |     /**
13 |      * Compose a field partial instance or file.
14 |      *
15 |      * @param  mixed  $partial
16 |      * @return array
17 |      *
18 |      * @deprecated Use `addPartial()` on Builder instead.
19 |      */
20 |     protected function get($partial = null)
21 |     {
22 |         if (
23 |             is_subclass_of($partial, Partial::class) &&
24 |             ! (new ReflectionClass($partial))->isAbstract()
25 |         ) {
26 |             return $partial::make($this->composer)->compose();
27 |         }
28 | 
29 |         if (is_a($partial, FieldsBuilder::class) || is_array($partial)) {
30 |             return $partial;
31 |         }
32 | 
33 |         if (file_exists($partial)) {
34 |             return include $partial;
35 |         }
36 | 
37 |         return file_exists(
38 |             $partial = $this->app->path(
39 |                 Str::finish(
40 |                     strtr($partial, ['.php' => '', '.' => '/']),
41 |                     '.php'
42 |                 )
43 |             )
44 |         ) ? include $partial : [];
45 |     }
46 | }
47 | 


--------------------------------------------------------------------------------
/src/Console/OptionsMakeCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Console;
 4 | 
 5 | class OptionsMakeCommand extends MakeCommand
 6 | {
 7 |     /**
 8 |      * The console command signature.
 9 |      *
10 |      * @var string
11 |      */
12 |     protected $signature = 'acf:options {name* : The name of the options page}
13 |                             {--full : Scaffold an options page that contains the complete configuration.}
14 |                             {--force : Overwrite any existing files}';
15 | 
16 |     /**
17 |      * The console command description.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $description = 'Create a new ACF options page.';
22 | 
23 |     /**
24 |      * The label used when referencing the command type.
25 |      *
26 |      * @var string
27 |      */
28 |     protected $label = 'Option Page';
29 | 
30 |     /**
31 |      * The type of class being generated.
32 |      *
33 |      * @var string
34 |      */
35 |     protected $type = 'Options';
36 | 
37 |     /**
38 |      * Get the stub file for the generator.
39 |      *
40 |      * @return string
41 |      */
42 |     protected function getStub()
43 |     {
44 |         if ($this->option('full')) {
45 |             return $this->resolveStub('options.full');
46 |         }
47 | 
48 |         return $this->resolveStub('options');
49 |     }
50 | }
51 | 


--------------------------------------------------------------------------------
/src/Console/stubs/widget.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DummyNamespace;
 4 | 
 5 | use Log1x\AcfComposer\Builder;
 6 | use Log1x\AcfComposer\Widget;
 7 | 
 8 | class DummyClass extends Widget
 9 | {
10 |     /**
11 |      * The widget name.
12 |      *
13 |      * @var string
14 |      */
15 |     public $name = 'DummyTitle';
16 | 
17 |     /**
18 |      * The widget description.
19 |      *
20 |      * @var string
21 |      */
22 |     public $description = 'DummyDescription';
23 | 
24 |     /**
25 |      * Data to be passed to the widget before rendering.
26 |      */
27 |     public function with(): array
28 |     {
29 |         return [
30 |             'items' => $this->items(),
31 |         ];
32 |     }
33 | 
34 |     /**
35 |      * The widget title.
36 |      */
37 |     public function title(): string
38 |     {
39 |         return get_field('title', $this->widget->id);
40 |     }
41 | 
42 |     /**
43 |      * The widget field group.
44 |      */
45 |     public function fields(): array
46 |     {
47 |         $fields = Builder::make('DummySnake');
48 | 
49 |         $fields
50 |             ->addText('title');
51 | 
52 |         $fields
53 |             ->addRepeater('items')
54 |                 ->addText('item')
55 |             ->endRepeater();
56 | 
57 |         return $fields->build();
58 |     }
59 | 
60 |     /**
61 |      * Return the items field.
62 |      *
63 |      * @return array
64 |      */
65 |     public function items()
66 |     {
67 |         return get_field('items', $this->widget->id) ?: [];
68 |     }
69 | }
70 | 


--------------------------------------------------------------------------------
/src/Console/WidgetMakeCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Console;
 4 | 
 5 | use Illuminate\Support\Str;
 6 | 
 7 | use function Laravel\Prompts\text;
 8 | 
 9 | class WidgetMakeCommand extends MakeCommand
10 | {
11 |     /**
12 |      * The console command signature.
13 |      *
14 |      * @var string
15 |      */
16 |     protected $signature = 'acf:widget {name* : The name of the widget}
17 |                                        {--force : Overwrite any existing files}';
18 | 
19 |     /**
20 |      * The console command description.
21 |      *
22 |      * @var string
23 |      */
24 |     protected $description = 'Create a new ACF sidebar widget.';
25 | 
26 |     /**
27 |      * The type of class being generated.
28 |      *
29 |      * @var string
30 |      */
31 |     protected $type = 'Widget';
32 | 
33 |     /**
34 |      * The view stub used when generated.
35 |      *
36 |      * @var string|bool
37 |      */
38 |     protected $view = 'widget';
39 | 
40 |     /**
41 |      * {@inheritdoc}
42 |      */
43 |     public function buildClass($name)
44 |     {
45 |         $stub = parent::buildClass($name);
46 | 
47 |         $name = Str::of($name)
48 |             ->afterLast('\\')
49 |             ->kebab()
50 |             ->headline()
51 |             ->replace('-', ' ');
52 | 
53 |         $description = "A beautiful {$name} widget.";
54 | 
55 |         $description = text(
56 |             label: 'Enter the widget description',
57 |             placeholder: $description,
58 |         ) ?: $description;
59 | 
60 |         $stub = str_replace('DummyDescription', $description, $stub);
61 | 
62 |         return $stub;
63 |     }
64 | 
65 |     /**
66 |      * Get the stub file for the generator.
67 |      *
68 |      * @return string
69 |      */
70 |     protected function getStub()
71 |     {
72 |         return $this->resolveStub('widget');
73 |     }
74 | }
75 | 


--------------------------------------------------------------------------------
/src/Console/StubPublishCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Console;
 4 | 
 5 | use Illuminate\Filesystem\Filesystem;
 6 | use Log1x\AcfComposer\Concerns\HasCollection;
 7 | use Roots\Acorn\Console\Commands\Command;
 8 | 
 9 | class StubPublishCommand extends Command
10 | {
11 |     use HasCollection;
12 | 
13 |     /**
14 |      * The name and signature of the console command.
15 |      *
16 |      * @var string
17 |      */
18 |     protected $signature = 'acf:stubs {--force : Overwrite any existing files}';
19 | 
20 |     /**
21 |      * The console command description.
22 |      *
23 |      * @var string
24 |      */
25 |     protected $description = 'Publish the customizable ACF Composer stubs.';
26 | 
27 |     /**
28 |      * The available stubs.
29 |      *
30 |      * @var array
31 |      */
32 |     protected $stubs = [
33 |         'block.localized.stub',
34 |         'block.stub',
35 |         'field.stub',
36 |         'options.full.stub',
37 |         'options.stub',
38 |         'partial.stub',
39 |         'widget.stub',
40 |         'views/block.stub',
41 |         'views/widget.stub',
42 |     ];
43 | 
44 |     /**
45 |      * Execute the console command.
46 |      *
47 |      * @return void
48 |      */
49 |     public function handle()
50 |     {
51 |         if (! is_dir($stubsPath = $this->app->basePath('stubs/acf-composer'))) {
52 |             (new Filesystem)->makeDirectory($stubsPath, 0755, true);
53 |         }
54 | 
55 |         if (! is_dir($stubsPath.'/views')) {
56 |             (new Filesystem)->makeDirectory($stubsPath.'/views', 0755, true);
57 |         }
58 | 
59 |         $files = $this->collect($this->stubs)
60 |             ->mapWithKeys(function ($stub) use ($stubsPath) {
61 |                 return [__DIR__.'/stubs/'.$stub => $stubsPath.'/'.$stub];
62 |             })->toArray();
63 | 
64 |         foreach ($files as $from => $to) {
65 |             if (! file_exists($to) || $this->option('force')) {
66 |                 file_put_contents($to, file_get_contents($from));
67 |             }
68 |         }
69 | 
70 |         $this->info('🎉 ACF Composer stubs successfully published.');
71 |     }
72 | }
73 | 


--------------------------------------------------------------------------------
/src/Field.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer;
 4 | 
 5 | use Log1x\AcfComposer\Exceptions\InvalidFieldsException;
 6 | use StoutLogic\AcfBuilder\FieldsBuilder;
 7 | 
 8 | abstract class Field extends Composer
 9 | {
10 |     /**
11 |      * Register the field groups with Advanced Custom Fields.
12 |      */
13 |     protected function register(?callable $callback = null): void
14 |     {
15 |         if (empty($this->fields)) {
16 |             return;
17 |         }
18 | 
19 |         if ($callback) {
20 |             $callback();
21 |         }
22 | 
23 |         foreach ($this->fields as $fields) {
24 |             acf_add_local_field_group(
25 |                 $this->build($fields)
26 |             );
27 |         }
28 |     }
29 | 
30 |     /**
31 |      * Retrieve the field group fields.
32 |      */
33 |     public function getFields(bool $cache = true): array
34 |     {
35 |         if ($this->fields && $cache) {
36 |             return $this->fields;
37 |         }
38 | 
39 |         if ($cache && $this->composer->manifest()->has($this)) {
40 |             return $this->composer->manifest()->get($this);
41 |         }
42 | 
43 |         $fields = $this->resolveFields();
44 | 
45 |         if (blank($fields)) {
46 |             return [];
47 |         }
48 | 
49 |         $fields = is_a($fields, FieldsBuilder::class)
50 |             ? [$fields]
51 |             : $fields;
52 | 
53 |         if (! is_array($fields)) {
54 |             throw new InvalidFieldsException;
55 |         }
56 | 
57 |         $fields = ! empty($fields['key']) ? [$fields] : $fields;
58 | 
59 |         foreach ($fields as $key => $field) {
60 |             $fields[$key] = is_a($field, FieldsBuilder::class)
61 |                 ? $field->build()
62 |                 : $field;
63 |         }
64 | 
65 |         if ($this->defaults->has('field_group')) {
66 |             foreach ($fields as $key => $field) {
67 |                 $fields[$key] = array_merge($this->defaults->get('field_group'), $field);
68 |             }
69 |         }
70 | 
71 |         return $fields;
72 |     }
73 | 
74 |     /**
75 |      * Compose and register the defined field groups with ACF.
76 |      *
77 |      * @return mixed
78 |      */
79 |     public function compose()
80 |     {
81 |         if (empty($this->fields)) {
82 |             return;
83 |         }
84 | 
85 |         $this->register();
86 | 
87 |         return $this;
88 |     }
89 | }
90 | 


--------------------------------------------------------------------------------
/src/Providers/AcfComposerServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Providers;
 4 | 
 5 | use Composer\InstalledVersions;
 6 | use Illuminate\Foundation\Console\AboutCommand;
 7 | use Illuminate\Support\ServiceProvider;
 8 | use Log1x\AcfComposer\AcfComposer;
 9 | use Log1x\AcfComposer\Console;
10 | 
11 | class AcfComposerServiceProvider extends ServiceProvider
12 | {
13 |     /**
14 |      * Register any application services.
15 |      *
16 |      * @return void
17 |      */
18 |     public function register()
19 |     {
20 |         $this->app->singleton('AcfComposer', fn () => AcfComposer::make($this->app));
21 | 
22 |         if (! defined('PWP_NAME')) {
23 |             define('PWP_NAME', 'ACF Composer');
24 |         }
25 |     }
26 | 
27 |     /**
28 |      * Bootstrap any application services.
29 |      *
30 |      * @return void
31 |      */
32 |     public function boot()
33 |     {
34 |         $this->publishes([
35 |             __DIR__.'/../../config/acf.php' => $this->app->configPath('acf.php'),
36 |         ], 'acf-composer');
37 | 
38 |         $this->loadViewsFrom(__DIR__.'/../../resources/views', 'acf-composer');
39 |         $this->mergeConfigFrom(__DIR__.'/../../config/acf.php', 'acf');
40 | 
41 |         $composer = $this->app->make('AcfComposer');
42 | 
43 |         $composer->boot();
44 | 
45 |         if ($this->app->runningInConsole()) {
46 |             $this->commands([
47 |                 Console\BlockMakeCommand::class,
48 |                 Console\CacheCommand::class,
49 |                 Console\ClearCommand::class,
50 |                 Console\FieldMakeCommand::class,
51 |                 Console\IdeHelpersCommand::class,
52 |                 Console\OptionsMakeCommand::class,
53 |                 Console\PartialMakeCommand::class,
54 |                 Console\StubPublishCommand::class,
55 |                 Console\UpgradeCommand::class,
56 |                 Console\UsageCommand::class,
57 |                 Console\WidgetMakeCommand::class,
58 |             ]);
59 | 
60 |             if (class_exists(AboutCommand::class) && class_exists(InstalledVersions::class)) {
61 |                 AboutCommand::add('ACF Composer', [
62 |                     'Status' => $composer->manifest()->exists() ? '<fg=green;options=bold>CACHED</>' : '<fg=yellow;options=bold>NOT CACHED</>',
63 |                     'Version' => InstalledVersions::getPrettyVersion('log1x/acf-composer'),
64 |                 ]);
65 |             }
66 | 
67 |             if (method_exists($this, 'optimizes')) {
68 |                 $this->optimizes(
69 |                     optimize: 'acf:cache',
70 |                     clear: 'acf:clear',
71 |                     key: 'acf-composer',
72 |                 );
73 |             }
74 |         }
75 |     }
76 | }
77 | 


--------------------------------------------------------------------------------
/src/Console/stubs/options.full.stub:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace DummyNamespace;
  4 | 
  5 | use Log1x\AcfComposer\Builder;
  6 | use Log1x\AcfComposer\Options as Field;
  7 | 
  8 | class DummyClass extends Field
  9 | {
 10 |     /**
 11 |      * The option page menu name.
 12 |      *
 13 |      * @var string
 14 |      */
 15 |     public $name = 'DummyTitle';
 16 | 
 17 |     /**
 18 |      * The option page menu slug.
 19 |      *
 20 |      * @var string
 21 |      */
 22 |     public $slug = 'DummySlug';
 23 | 
 24 |     /**
 25 |      * The option page document title.
 26 |      *
 27 |      * @var string
 28 |      */
 29 |     public $title = 'DummyTitle | Options';
 30 | 
 31 |     /**
 32 |      * The option page permission capability.
 33 |      *
 34 |      * @var string
 35 |      */
 36 |     public $capability = 'edit_theme_options';
 37 | 
 38 |     /**
 39 |      * The option page menu position.
 40 |      *
 41 |      * @var int
 42 |      */
 43 |     public $position = PHP_INT_MAX;
 44 | 
 45 |     /**
 46 |      * The option page visibility in the admin menu.
 47 |      *
 48 |      * @var boolean
 49 |      */
 50 |     public $menu = true;
 51 | 
 52 |     /**
 53 |      * The slug of another admin page to be used as a parent.
 54 |      *
 55 |      * @var string
 56 |      */
 57 |     public $parent = null;
 58 | 
 59 |     /**
 60 |      * The option page menu icon.
 61 |      *
 62 |      * @var string
 63 |      */
 64 |     public $icon = null;
 65 | 
 66 |     /**
 67 |      * Redirect to the first child page if one exists.
 68 |      *
 69 |      * @var boolean
 70 |      */
 71 |     public $redirect = true;
 72 | 
 73 |     /**
 74 |      * The post ID to save and load values from.
 75 |      *
 76 |      * @var string|int
 77 |      */
 78 |     public $post = 'options';
 79 | 
 80 |     /**
 81 |      * The option page autoload setting.
 82 |      *
 83 |      * @var bool
 84 |      */
 85 |     public $autoload = true;
 86 | 
 87 |     /**
 88 |      * The additional option page settings.
 89 |      *
 90 |      * @var array
 91 |      */
 92 |     public $settings = [];
 93 | 
 94 |     /**
 95 |      * Localized text displayed on the submit button.
 96 |      */
 97 |     public function updateButton(): string
 98 |     {
 99 |         return __('Update', 'acf');
100 |     }
101 | 
102 |     /**
103 |      * Localized text displayed after form submission.
104 |      */
105 |     public function updatedMessage(): string
106 |     {
107 |         return __('DummyTitle Updated', 'acf');
108 |     }
109 | 
110 |     /**
111 |      * The option page field group.
112 |      */
113 |     public function fields(): array
114 |     {
115 |         $fields = Builder::make('DummySnake');
116 | 
117 |         $fields
118 |             ->addRepeater('items')
119 |                 ->addText('item')
120 |             ->endRepeater();
121 | 
122 |         return $fields->build();
123 |     }
124 | }
125 | 


--------------------------------------------------------------------------------
/config/acf.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | return [
 4 | 
 5 |     /*
 6 |     |--------------------------------------------------------------------------
 7 |     | Default Field Type Settings
 8 |     |--------------------------------------------------------------------------
 9 |     |
10 |     | Here you can set default field group and field type configuration that
11 |     | is then merged with your field groups when they are composed.
12 |     |
13 |     | This allows you to avoid the repetitive process of setting common field
14 |     | configuration such as `ui` on every `trueFalse` field or your
15 |     | preferred `instruction_placement` on every `fieldGroup`.
16 |     |
17 |     */
18 | 
19 |     'defaults' => [
20 |         // 'trueFalse' => ['ui' => 1],
21 |         // 'select' => ['ui' => 1],
22 |     ],
23 | 
24 |     /*
25 |     |--------------------------------------------------------------------------
26 |     | Custom Field Types
27 |     |--------------------------------------------------------------------------
28 |     |
29 |     | Here you can define custom field types that are not included with ACF
30 |     | out of the box. This allows you to use the fluent builder pattern with
31 |     | custom field types such as `addEditorPalette()`.
32 |     |
33 |     */
34 | 
35 |     'types' => [
36 |         // 'editorPalette' => 'editor_palette',
37 |         // 'phoneNumber' => 'phone_number',
38 |     ],
39 | 
40 |     /*
41 |     |--------------------------------------------------------------------------
42 |     | Default Block Settings
43 |     |--------------------------------------------------------------------------
44 |     |
45 |     | Here you may define default settings to merge with your block definition
46 |     | during composition. Any settings defined on the block will take
47 |     | precedence over these defaults.
48 |     |
49 |     */
50 | 
51 |     'blocks' => [
52 |         'apiVersion' => 2,
53 |     ],
54 | 
55 |     /*
56 |     |--------------------------------------------------------------------------
57 |     | Generators
58 |     |--------------------------------------------------------------------------
59 |     |
60 |     | Here you may specify defaults used when generating Composer classes in
61 |     | your application.
62 |     |
63 |     */
64 | 
65 |     'generators' => [
66 |         'supports' => ['align', 'mode', 'multiple', 'jsx'],
67 |     ],
68 | 
69 |     /*
70 |     |--------------------------------------------------------------------------
71 |     | Cache Manifest Path
72 |     |--------------------------------------------------------------------------
73 |     |
74 |     | Here you can define the cache manifest path. Fields are typically cached
75 |     | when running the `acf:cache` command. This will cache the built field
76 |     | groups and potentially improve performance in complex applications.
77 |     |
78 |     */
79 | 
80 |     'manifest' => storage_path('framework/cache'),
81 | 
82 | ];
83 | 


--------------------------------------------------------------------------------
/src/Console/IdeHelpersCommand.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Log1x\AcfComposer\Console;
  4 | 
  5 | use Illuminate\Console\Command;
  6 | use Illuminate\Support\Facades\File;
  7 | use Illuminate\Support\Str;
  8 | 
  9 | class IdeHelpersCommand extends Command
 10 | {
 11 |     /**
 12 |      * The name and signature of the console command.
 13 |      *
 14 |      * @var string
 15 |      */
 16 |     protected $signature = 'acf:ide-helpers
 17 |                             {--path= : The path to generate the IDE helpers}';
 18 | 
 19 |     /**
 20 |      * The console command description.
 21 |      *
 22 |      * @var string
 23 |      */
 24 |     protected $description = 'Generate IDE helpers for configured custom field types';
 25 | 
 26 |     /**
 27 |      * Execute the console command.
 28 |      */
 29 |     public function handle()
 30 |     {
 31 |         $types = config('acf.types', []);
 32 | 
 33 |         if (! $types) {
 34 |             return $this->components->info('You <fg=blue>do not</> have any configured custom field types.');
 35 |         }
 36 | 
 37 |         $path = $this->option('path') ?
 38 |             base_path($this->option('path')) :
 39 |             __DIR__.'/../../_ide-helpers.php';
 40 | 
 41 |         $methods = [];
 42 | 
 43 |         foreach ($types as $key => $value) {
 44 |             $key = Str::studly($key);
 45 | 
 46 |             $methods[] = "* @method \Log1x\AcfComposer\Builder\FieldBuilder add{$key}(string \$name, array \$args = [])";
 47 |         }
 48 | 
 49 |         $methods = implode("\n\t ", $methods);
 50 | 
 51 |         $builder = <<<EOT
 52 |         namespace Log1x\AcfComposer {
 53 |             /**
 54 |              {$methods}
 55 |              */
 56 |             class Builder
 57 |             {
 58 |             }
 59 |         }
 60 |         EOT;
 61 | 
 62 |         $fieldBuilder = <<<EOT
 63 |         namespace Log1x\AcfComposer\Builder {
 64 |             /**
 65 |              {$methods}
 66 |              */
 67 |             class FieldBuilder
 68 |             {
 69 |             }
 70 | 
 71 |             /**
 72 |              {$methods}
 73 |              */
 74 |             class GroupBuilder
 75 |             {
 76 |             }
 77 | 
 78 |             /**
 79 |              {$methods}
 80 |              */
 81 |             class RepeaterBuilder
 82 |             {
 83 |             }
 84 | 
 85 |             /**
 86 |              {$methods}
 87 |              */
 88 |             class AccordionBuilder
 89 |             {
 90 |             }
 91 | 
 92 |             /**
 93 |              {$methods}
 94 |              */
 95 |             class TabBuilder
 96 |             {
 97 |             }
 98 | 
 99 |             /**
100 |              {$methods}
101 |              */
102 |             class ChoiceFieldBuilder
103 |             {
104 |             }
105 |         }
106 |         EOT;
107 | 
108 |         File::put($path, "<?php\n\n{$builder}\n\n{$fieldBuilder}");
109 | 
110 |         $this->components->info('The <fg=blue>IDE helpers</> have been successfully generated.');
111 |     }
112 | }
113 | 


--------------------------------------------------------------------------------
/src/Console/CacheCommand.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Log1x\AcfComposer\Console;
  4 | 
  5 | use Illuminate\Console\Command;
  6 | use Log1x\AcfComposer\AcfComposer;
  7 | use Log1x\AcfComposer\Concerns\HasCollection;
  8 | 
  9 | class CacheCommand extends Command
 10 | {
 11 |     use HasCollection;
 12 | 
 13 |     /**
 14 |      * The name and signature of the console command.
 15 |      *
 16 |      * @var string
 17 |      */
 18 |     protected $signature = 'acf:cache
 19 |                             {--clear : Clear the cache}
 20 |                             {--status : Show the current cache status}
 21 |                             {--manifest : Only write the field group manifest}
 22 |                             {--force : Ignore errors when writing cache}';
 23 | 
 24 |     /**
 25 |      * The console command description.
 26 |      *
 27 |      * @var string
 28 |      */
 29 |     protected $description = 'Cache the ACF Composer field groups and blocks.';
 30 | 
 31 |     /**
 32 |      * The ACF Composer instance.
 33 |      */
 34 |     protected AcfComposer $composer;
 35 | 
 36 |     /**
 37 |      * The cached field group count.
 38 |      */
 39 |     protected int $count = 0;
 40 | 
 41 |     /**
 42 |      * Execute the console command.
 43 |      */
 44 |     public function handle()
 45 |     {
 46 |         $this->composer = $this->laravel['AcfComposer'];
 47 | 
 48 |         if ($this->option('clear')) {
 49 |             return $this->call('acf:clear');
 50 |         }
 51 | 
 52 |         if ($this->option('status')) {
 53 |             $status = $this->composer->manifest()->exists()
 54 |                 ? '<fg=green;options=bold>cached</>'
 55 |                 : '<fg=red;options=bold>not cached</>';
 56 | 
 57 |             return $this->components->info("<fg=blue>ACF Composer</> is currently {$status}.");
 58 |         }
 59 | 
 60 |         $composers = $this->collect(
 61 |             $this->composer->composers()
 62 |         )->flatten();
 63 | 
 64 |         $composers->each(function ($composer) {
 65 |             if (! $this->composer->manifest()->add($composer)) {
 66 |                 $name = $composer::class;
 67 | 
 68 |                 return $this->components->error("Failed to add <fg=red>{$name}</> to the manifest.");
 69 |             }
 70 | 
 71 |             $this->count++;
 72 |         });
 73 | 
 74 |         if ($this->count !== $composers->count() && ! $this->option('force')) {
 75 |             return $this->components->error('Failed to cache the <fg=red>ACF Composer</> field groups.');
 76 |         }
 77 | 
 78 |         if (! $manifest = $this->composer->manifest()->write()) {
 79 |             return $this->components->error('Failed to write the <fg=red>ACF Composer</> manifest.');
 80 |         }
 81 | 
 82 |         $blocks = ! $this->option('manifest')
 83 |             ? $this->composer->manifest()->writeBlocks()
 84 |             : 0;
 85 | 
 86 |         $this->components->info("Successfully cached <fg=blue>{$manifest}</> field group(s) and <fg=blue>{$blocks}</> block(s).");
 87 |     }
 88 | 
 89 |     /**
 90 |      * Configure the command.
 91 |      *
 92 |      * @return void
 93 |      */
 94 |     public function configure()
 95 |     {
 96 |         $this->setAliases([
 97 |             'acf:optimize',
 98 |         ]);
 99 |     }
100 | }
101 | 


--------------------------------------------------------------------------------
/src/Builder/ChoiceFieldBuilder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Builder;
 4 | 
 5 | use StoutLogic\AcfBuilder\ChoiceFieldBuilder as ChoiceFieldBuilderBase;
 6 | 
 7 | /**
 8 |  * @method AccordionBuilder addAccordion(string $label, array $args = [])
 9 |  * @method Builder addLayout(string|FieldsBuilder $layout, array $args = [])
10 |  * @method Builder endFlexibleContent()
11 |  * @method Builder endGroup()
12 |  * @method Builder endRepeater()
13 |  * @method Builder modifyField(string $name, array|\Closure $modify)
14 |  * @method ChoiceFieldBuilder addButtonGroup(string $name, array $args = [])
15 |  * @method ChoiceFieldBuilder addCheckbox(string $name, array $args = [])
16 |  * @method ChoiceFieldBuilder addChoiceField(string $name, string $type, array $args = [])
17 |  * @method ChoiceFieldBuilder addRadio(string $name, array $args = [])
18 |  * @method ChoiceFieldBuilder addSelect(string $name, array $args = [])
19 |  * @method FieldBuilder addColorPicker(string $name, array $args = [])
20 |  * @method FieldBuilder addDatePicker(string $name, array $args = [])
21 |  * @method FieldBuilder addDateTimePicker(string $name, array $args = [])
22 |  * @method FieldBuilder addEmail(string $name, array $args = [])
23 |  * @method FieldBuilder addField(string $name, string $type, array $args = [])
24 |  * @method FieldBuilder addFields(FieldsBuilder|array $fields)
25 |  * @method FieldBuilder addFile(string $name, array $args = [])
26 |  * @method FieldBuilder addGallery(string $name, array $args = [])
27 |  * @method FieldBuilder addGoogleMap(string $name, array $args = [])
28 |  * @method FieldBuilder addImage(string $name, array $args = [])
29 |  * @method FieldBuilder addLink(string $name, array $args = [])
30 |  * @method FieldBuilder addMessage(string $label, string $message, array $args = [])
31 |  * @method FieldBuilder addNumber(string $name, array $args = [])
32 |  * @method FieldBuilder addOembed(string $name, array $args = [])
33 |  * @method FieldBuilder addPageLink(string $name, array $args = [])
34 |  * @method FieldBuilder addPartial(string $partial, array $args = [])
35 |  * @method FieldBuilder addPartials(array $partials)
36 |  * @method FieldBuilder addPassword(string $name, array $args = [])
37 |  * @method FieldBuilder addPostObject(string $name, array $args = [])
38 |  * @method FieldBuilder addRange(string $name, array $args = [])
39 |  * @method FieldBuilder addRelationship(string $name, array $args = [])
40 |  * @method FieldBuilder addTaxonomy(string $name, array $args = [])
41 |  * @method FieldBuilder addText(string $name, array $args = [])
42 |  * @method FieldBuilder addTextarea(string $name, array $args = [])
43 |  * @method FieldBuilder addTimePicker(string $name, array $args = [])
44 |  * @method FieldBuilder addTrueFalse(string $name, array $args = [])
45 |  * @method FieldBuilder addUrl(string $name, array $args = [])
46 |  * @method FieldBuilder addUser(string $name, array $args = [])
47 |  * @method FieldBuilder addWysiwyg(string $name, array $args = [])
48 |  * @method FlexibleContentBuilder addFlexibleContent(string $name, array $args = [])
49 |  * @method GroupBuilder addGroup(string $name, array $args = [])
50 |  * @method GroupBuilder end()
51 |  * @method LocationBuilder setLocation(string $param, string $operator, string $value)
52 |  * @method RepeaterBuilder addRepeater(string $name, array $args = [])
53 |  * @method TabBuilder addTab(string $label, array $args = [])
54 |  */
55 | class ChoiceFieldBuilder extends ChoiceFieldBuilderBase
56 | {
57 |     //
58 | }
59 | 


--------------------------------------------------------------------------------
/src/Builder/TabBuilder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Builder;
 4 | 
 5 | use StoutLogic\AcfBuilder\TabBuilder as TabBuilderBase;
 6 | 
 7 | /**
 8 |  * @method AccordionBuilder addAccordion(string $label, array $args = [])
 9 |  * @method \Log1x\AcfComposer\Builder addLayout(string|FieldsBuilder $layout, array $args = [])
10 |  * @method \Log1x\AcfComposer\Builder endFlexibleContent()
11 |  * @method \Log1x\AcfComposer\Builder endGroup()
12 |  * @method \Log1x\AcfComposer\Builder endRepeater()
13 |  * @method \Log1x\AcfComposer\Builder modifyField(string $name, array|\Closure $modify)
14 |  * @method ChoiceFieldBuilder addButtonGroup(string $name, array $args = [])
15 |  * @method ChoiceFieldBuilder addCheckbox(string $name, array $args = [])
16 |  * @method ChoiceFieldBuilder addChoiceField(string $name, string $type, array $args = [])
17 |  * @method ChoiceFieldBuilder addRadio(string $name, array $args = [])
18 |  * @method ChoiceFieldBuilder addSelect(string $name, array $args = [])
19 |  * @method FieldBuilder addColorPicker(string $name, array $args = [])
20 |  * @method FieldBuilder addDatePicker(string $name, array $args = [])
21 |  * @method FieldBuilder addDateTimePicker(string $name, array $args = [])
22 |  * @method FieldBuilder addEmail(string $name, array $args = [])
23 |  * @method FieldBuilder addField(string $name, string $type, array $args = [])
24 |  * @method FieldBuilder addFields(FieldsBuilder|array $fields)
25 |  * @method FieldBuilder addFile(string $name, array $args = [])
26 |  * @method FieldBuilder addGallery(string $name, array $args = [])
27 |  * @method FieldBuilder addGoogleMap(string $name, array $args = [])
28 |  * @method FieldBuilder addImage(string $name, array $args = [])
29 |  * @method FieldBuilder addLink(string $name, array $args = [])
30 |  * @method FieldBuilder addMessage(string $label, string $message, array $args = [])
31 |  * @method FieldBuilder addNumber(string $name, array $args = [])
32 |  * @method FieldBuilder addOembed(string $name, array $args = [])
33 |  * @method FieldBuilder addPageLink(string $name, array $args = [])
34 |  * @method FieldBuilder addPartial(string $partial, array $args = [])
35 |  * @method FieldBuilder addPartials(array $partials)
36 |  * @method FieldBuilder addPassword(string $name, array $args = [])
37 |  * @method FieldBuilder addPostObject(string $name, array $args = [])
38 |  * @method FieldBuilder addRange(string $name, array $args = [])
39 |  * @method FieldBuilder addRelationship(string $name, array $args = [])
40 |  * @method FieldBuilder addTaxonomy(string $name, array $args = [])
41 |  * @method FieldBuilder addText(string $name, array $args = [])
42 |  * @method FieldBuilder addTextarea(string $name, array $args = [])
43 |  * @method FieldBuilder addTimePicker(string $name, array $args = [])
44 |  * @method FieldBuilder addTrueFalse(string $name, array $args = [])
45 |  * @method FieldBuilder addUrl(string $name, array $args = [])
46 |  * @method FieldBuilder addUser(string $name, array $args = [])
47 |  * @method FieldBuilder addWysiwyg(string $name, array $args = [])
48 |  * @method FlexibleContentBuilder addFlexibleContent(string $name, array $args = [])
49 |  * @method GroupBuilder addGroup(string $name, array $args = [])
50 |  * @method GroupBuilder end()
51 |  * @method LocationBuilder setLocation(string $param, string $operator, string $value)
52 |  * @method RepeaterBuilder addRepeater(string $name, array $args = [])
53 |  * @method TabBuilder addTab(string $label, array $args = [])
54 |  */
55 | class TabBuilder extends TabBuilderBase
56 | {
57 |     //
58 | }
59 | 


--------------------------------------------------------------------------------
/src/Builder/AccordionBuilder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Builder;
 4 | 
 5 | use StoutLogic\AcfBuilder\AccordionBuilder as AccordionBuilderBase;
 6 | 
 7 | /**
 8 |  * @method AccordionBuilder addAccordion(string $label, array $args = [])
 9 |  * @method \Log1x\AcfComposer\Builder addLayout(string|FieldsBuilder $layout, array $args = [])
10 |  * @method \Log1x\AcfComposer\Builder endFlexibleContent()
11 |  * @method \Log1x\AcfComposer\Builder endGroup()
12 |  * @method \Log1x\AcfComposer\Builder endRepeater()
13 |  * @method \Log1x\AcfComposer\Builder modifyField(string $name, array|\Closure $modify)
14 |  * @method ChoiceFieldBuilder addButtonGroup(string $name, array $args = [])
15 |  * @method ChoiceFieldBuilder addCheckbox(string $name, array $args = [])
16 |  * @method ChoiceFieldBuilder addChoiceField(string $name, string $type, array $args = [])
17 |  * @method ChoiceFieldBuilder addRadio(string $name, array $args = [])
18 |  * @method ChoiceFieldBuilder addSelect(string $name, array $args = [])
19 |  * @method FieldBuilder addColorPicker(string $name, array $args = [])
20 |  * @method FieldBuilder addDatePicker(string $name, array $args = [])
21 |  * @method FieldBuilder addDateTimePicker(string $name, array $args = [])
22 |  * @method FieldBuilder addEmail(string $name, array $args = [])
23 |  * @method FieldBuilder addField(string $name, string $type, array $args = [])
24 |  * @method FieldBuilder addFields(FieldsBuilder|array $fields)
25 |  * @method FieldBuilder addFile(string $name, array $args = [])
26 |  * @method FieldBuilder addGallery(string $name, array $args = [])
27 |  * @method FieldBuilder addGoogleMap(string $name, array $args = [])
28 |  * @method FieldBuilder addImage(string $name, array $args = [])
29 |  * @method FieldBuilder addLink(string $name, array $args = [])
30 |  * @method FieldBuilder addMessage(string $label, string $message, array $args = [])
31 |  * @method FieldBuilder addNumber(string $name, array $args = [])
32 |  * @method FieldBuilder addOembed(string $name, array $args = [])
33 |  * @method FieldBuilder addPageLink(string $name, array $args = [])
34 |  * @method FieldBuilder addPartial(string $partial, array $args = [])
35 |  * @method FieldBuilder addPartials(array $partials)
36 |  * @method FieldBuilder addPassword(string $name, array $args = [])
37 |  * @method FieldBuilder addPostObject(string $name, array $args = [])
38 |  * @method FieldBuilder addRange(string $name, array $args = [])
39 |  * @method FieldBuilder addRelationship(string $name, array $args = [])
40 |  * @method FieldBuilder addTaxonomy(string $name, array $args = [])
41 |  * @method FieldBuilder addText(string $name, array $args = [])
42 |  * @method FieldBuilder addTextarea(string $name, array $args = [])
43 |  * @method FieldBuilder addTimePicker(string $name, array $args = [])
44 |  * @method FieldBuilder addTrueFalse(string $name, array $args = [])
45 |  * @method FieldBuilder addUrl(string $name, array $args = [])
46 |  * @method FieldBuilder addUser(string $name, array $args = [])
47 |  * @method FieldBuilder addWysiwyg(string $name, array $args = [])
48 |  * @method FlexibleContentBuilder addFlexibleContent(string $name, array $args = [])
49 |  * @method GroupBuilder addGroup(string $name, array $args = [])
50 |  * @method GroupBuilder end()
51 |  * @method LocationBuilder setLocation(string $param, string $operator, string $value)
52 |  * @method RepeaterBuilder addRepeater(string $name, array $args = [])
53 |  * @method TabBuilder addTab(string $label, array $args = [])
54 |  */
55 | class AccordionBuilder extends AccordionBuilderBase
56 | {
57 |     //
58 | }
59 | 


--------------------------------------------------------------------------------
/src/Builder/FieldBuilder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Builder;
 4 | 
 5 | use Log1x\AcfComposer\Builder;
 6 | use StoutLogic\AcfBuilder\FieldBuilder as FieldBuilderBase;
 7 | use StoutLogic\AcfBuilder\FieldsBuilder;
 8 | use StoutLogic\AcfBuilder\LocationBuilder;
 9 | 
10 | /**
11 |  * @method AccordionBuilder addAccordion(string $label, array $args = [])
12 |  * @method Builder addLayout(string|FieldsBuilder $layout, array $args = [])
13 |  * @method Builder endFlexibleContent()
14 |  * @method Builder endGroup()
15 |  * @method Builder endRepeater()
16 |  * @method Builder modifyField(string $name, array|\Closure $modify)
17 |  * @method ChoiceFieldBuilder addButtonGroup(string $name, array $args = [])
18 |  * @method ChoiceFieldBuilder addCheckbox(string $name, array $args = [])
19 |  * @method ChoiceFieldBuilder addChoiceField(string $name, string $type, array $args = [])
20 |  * @method ChoiceFieldBuilder addRadio(string $name, array $args = [])
21 |  * @method ChoiceFieldBuilder addSelect(string $name, array $args = [])
22 |  * @method FieldBuilder addColorPicker(string $name, array $args = [])
23 |  * @method FieldBuilder addDatePicker(string $name, array $args = [])
24 |  * @method FieldBuilder addDateTimePicker(string $name, array $args = [])
25 |  * @method FieldBuilder addEmail(string $name, array $args = [])
26 |  * @method FieldBuilder addField(string $name, string $type, array $args = [])
27 |  * @method FieldBuilder addFields(FieldsBuilder|array $fields)
28 |  * @method FieldBuilder addFile(string $name, array $args = [])
29 |  * @method FieldBuilder addGallery(string $name, array $args = [])
30 |  * @method FieldBuilder addGoogleMap(string $name, array $args = [])
31 |  * @method FieldBuilder addImage(string $name, array $args = [])
32 |  * @method FieldBuilder addLink(string $name, array $args = [])
33 |  * @method FieldBuilder addMessage(string $label, string $message, array $args = [])
34 |  * @method FieldBuilder addNumber(string $name, array $args = [])
35 |  * @method FieldBuilder addOembed(string $name, array $args = [])
36 |  * @method FieldBuilder addPageLink(string $name, array $args = [])
37 |  * @method FieldBuilder addPartial(string $partial, array $args = [])
38 |  * @method FieldBuilder addPartials(array $partials)
39 |  * @method FieldBuilder addPassword(string $name, array $args = [])
40 |  * @method FieldBuilder addPostObject(string $name, array $args = [])
41 |  * @method FieldBuilder addRange(string $name, array $args = [])
42 |  * @method FieldBuilder addRelationship(string $name, array $args = [])
43 |  * @method FieldBuilder addTaxonomy(string $name, array $args = [])
44 |  * @method FieldBuilder addText(string $name, array $args = [])
45 |  * @method FieldBuilder addTextarea(string $name, array $args = [])
46 |  * @method FieldBuilder addTimePicker(string $name, array $args = [])
47 |  * @method FieldBuilder addTrueFalse(string $name, array $args = [])
48 |  * @method FieldBuilder addUrl(string $name, array $args = [])
49 |  * @method FieldBuilder addUser(string $name, array $args = [])
50 |  * @method FieldBuilder addWysiwyg(string $name, array $args = [])
51 |  * @method FlexibleContentBuilder addFlexibleContent(string $name, array $args = [])
52 |  * @method GroupBuilder addGroup(string $name, array $args = [])
53 |  * @method GroupBuilder end()
54 |  * @method LocationBuilder setLocation(string $param, string $operator, string $value)
55 |  * @method RepeaterBuilder addRepeater(string $name, array $args = [])
56 |  * @method TabBuilder addTab(string $label, array $args = [])
57 |  */
58 | class FieldBuilder extends FieldBuilderBase
59 | {
60 |     //
61 | }
62 | 


--------------------------------------------------------------------------------
/src/Builder/GroupBuilder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Builder;
 4 | 
 5 | use Log1x\AcfComposer\Builder;
 6 | use Log1x\AcfComposer\Builder\Concerns\HasParentContext;
 7 | use StoutLogic\AcfBuilder\GroupBuilder as GroupBuilderBase;
 8 | 
 9 | /**
10 |  * @method AccordionBuilder addAccordion(string $label, array $args = [])
11 |  * @method Builder addLayout(string|FieldsBuilder $layout, array $args = [])
12 |  * @method Builder endFlexibleContent()
13 |  * @method Builder endGroup()
14 |  * @method Builder endRepeater()
15 |  * @method Builder modifyField(string $name, array|\Closure $modify)
16 |  * @method ChoiceFieldBuilder addButtonGroup(string $name, array $args = [])
17 |  * @method ChoiceFieldBuilder addCheckbox(string $name, array $args = [])
18 |  * @method ChoiceFieldBuilder addChoiceField(string $name, string $type, array $args = [])
19 |  * @method ChoiceFieldBuilder addRadio(string $name, array $args = [])
20 |  * @method ChoiceFieldBuilder addSelect(string $name, array $args = [])
21 |  * @method FieldBuilder addColorPicker(string $name, array $args = [])
22 |  * @method FieldBuilder addDatePicker(string $name, array $args = [])
23 |  * @method FieldBuilder addDateTimePicker(string $name, array $args = [])
24 |  * @method FieldBuilder addEmail(string $name, array $args = [])
25 |  * @method FieldBuilder addField(string $name, string $type, array $args = [])
26 |  * @method FieldBuilder addFields(FieldsBuilder|array $fields)
27 |  * @method FieldBuilder addFile(string $name, array $args = [])
28 |  * @method FieldBuilder addGallery(string $name, array $args = [])
29 |  * @method FieldBuilder addGoogleMap(string $name, array $args = [])
30 |  * @method FieldBuilder addImage(string $name, array $args = [])
31 |  * @method FieldBuilder addLink(string $name, array $args = [])
32 |  * @method FieldBuilder addMessage(string $label, string $message, array $args = [])
33 |  * @method FieldBuilder addNumber(string $name, array $args = [])
34 |  * @method FieldBuilder addOembed(string $name, array $args = [])
35 |  * @method FieldBuilder addPageLink(string $name, array $args = [])
36 |  * @method FieldBuilder addPartial(string $partial, array $args = [])
37 |  * @method FieldBuilder addPartials(array $partials)
38 |  * @method FieldBuilder addPassword(string $name, array $args = [])
39 |  * @method FieldBuilder addPostObject(string $name, array $args = [])
40 |  * @method FieldBuilder addRange(string $name, array $args = [])
41 |  * @method FieldBuilder addRelationship(string $name, array $args = [])
42 |  * @method FieldBuilder addTaxonomy(string $name, array $args = [])
43 |  * @method FieldBuilder addText(string $name, array $args = [])
44 |  * @method FieldBuilder addTextarea(string $name, array $args = [])
45 |  * @method FieldBuilder addTimePicker(string $name, array $args = [])
46 |  * @method FieldBuilder addTrueFalse(string $name, array $args = [])
47 |  * @method FieldBuilder addUrl(string $name, array $args = [])
48 |  * @method FieldBuilder addUser(string $name, array $args = [])
49 |  * @method FieldBuilder addWysiwyg(string $name, array $args = [])
50 |  * @method FlexibleContentBuilder addFlexibleContent(string $name, array $args = [])
51 |  * @method GroupBuilder addGroup(string $name, array $args = [])
52 |  * @method GroupBuilder end()
53 |  * @method LocationBuilder setLocation(string $param, string $operator, string $value)
54 |  * @method RepeaterBuilder addRepeater(string $name, array $args = [])
55 |  * @method TabBuilder addTab(string $label, array $args = [])
56 |  */
57 | class GroupBuilder extends GroupBuilderBase
58 | {
59 |     use HasParentContext;
60 | 
61 |     /**
62 |      * The fields builder instance.
63 |      *
64 |      * @var \Log1x\AcfComposer\Builder
65 |      */
66 |     protected $fieldsBuilder;
67 | 
68 |     /**
69 |      * {@inheritdoc}
70 |      */
71 |     public function __construct($name, $type = 'group', $config = [])
72 |     {
73 |         parent::__construct($name, $type, $config);
74 | 
75 |         $this->fieldsBuilder = Builder::make($name);
76 | 
77 |         $this->fieldsBuilder->setParentContext($this);
78 |     }
79 | }
80 | 


--------------------------------------------------------------------------------
/src/Builder/RepeaterBuilder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Builder;
 4 | 
 5 | use Log1x\AcfComposer\Builder;
 6 | use Log1x\AcfComposer\Builder\Concerns\HasParentContext;
 7 | use StoutLogic\AcfBuilder\RepeaterBuilder as GroupBuilder;
 8 | 
 9 | /**
10 |  * @method AccordionBuilder addAccordion(string $label, array $args = [])
11 |  * @method Builder addLayout(string|FieldsBuilder $layout, array $args = [])
12 |  * @method Builder endFlexibleContent()
13 |  * @method Builder endGroup()
14 |  * @method Builder endRepeater()
15 |  * @method Builder modifyField(string $name, array|\Closure $modify)
16 |  * @method ChoiceFieldBuilder addButtonGroup(string $name, array $args = [])
17 |  * @method ChoiceFieldBuilder addCheckbox(string $name, array $args = [])
18 |  * @method ChoiceFieldBuilder addChoiceField(string $name, string $type, array $args = [])
19 |  * @method ChoiceFieldBuilder addRadio(string $name, array $args = [])
20 |  * @method ChoiceFieldBuilder addSelect(string $name, array $args = [])
21 |  * @method FieldBuilder addColorPicker(string $name, array $args = [])
22 |  * @method FieldBuilder addDatePicker(string $name, array $args = [])
23 |  * @method FieldBuilder addDateTimePicker(string $name, array $args = [])
24 |  * @method FieldBuilder addEmail(string $name, array $args = [])
25 |  * @method FieldBuilder addField(string $name, string $type, array $args = [])
26 |  * @method FieldBuilder addFields(FieldsBuilder|array $fields)
27 |  * @method FieldBuilder addFile(string $name, array $args = [])
28 |  * @method FieldBuilder addGallery(string $name, array $args = [])
29 |  * @method FieldBuilder addGoogleMap(string $name, array $args = [])
30 |  * @method FieldBuilder addImage(string $name, array $args = [])
31 |  * @method FieldBuilder addLink(string $name, array $args = [])
32 |  * @method FieldBuilder addMessage(string $label, string $message, array $args = [])
33 |  * @method FieldBuilder addNumber(string $name, array $args = [])
34 |  * @method FieldBuilder addOembed(string $name, array $args = [])
35 |  * @method FieldBuilder addPageLink(string $name, array $args = [])
36 |  * @method FieldBuilder addPartial(string $partial, array $args = [])
37 |  * @method FieldBuilder addPartials(array $partials)
38 |  * @method FieldBuilder addPassword(string $name, array $args = [])
39 |  * @method FieldBuilder addPostObject(string $name, array $args = [])
40 |  * @method FieldBuilder addRange(string $name, array $args = [])
41 |  * @method FieldBuilder addRelationship(string $name, array $args = [])
42 |  * @method FieldBuilder addTaxonomy(string $name, array $args = [])
43 |  * @method FieldBuilder addText(string $name, array $args = [])
44 |  * @method FieldBuilder addTextarea(string $name, array $args = [])
45 |  * @method FieldBuilder addTimePicker(string $name, array $args = [])
46 |  * @method FieldBuilder addTrueFalse(string $name, array $args = [])
47 |  * @method FieldBuilder addUrl(string $name, array $args = [])
48 |  * @method FieldBuilder addUser(string $name, array $args = [])
49 |  * @method FieldBuilder addWysiwyg(string $name, array $args = [])
50 |  * @method FlexibleContentBuilder addFlexibleContent(string $name, array $args = [])
51 |  * @method GroupBuilder addGroup(string $name, array $args = [])
52 |  * @method GroupBuilder end()
53 |  * @method LocationBuilder setLocation(string $param, string $operator, string $value)
54 |  * @method RepeaterBuilder addRepeater(string $name, array $args = [])
55 |  * @method TabBuilder addTab(string $label, array $args = [])
56 |  */
57 | class RepeaterBuilder extends GroupBuilder
58 | {
59 |     use HasParentContext;
60 | 
61 |     /**
62 |      * The fields builder instance.
63 |      *
64 |      * @var \Log1x\AcfComposer\Builder
65 |      */
66 |     protected $fieldsBuilder;
67 | 
68 |     /**
69 |      * {@inheritdoc}
70 |      */
71 |     public function __construct($name, $type = 'repeater', $config = [])
72 |     {
73 |         parent::__construct($name, $type, $config);
74 | 
75 |         $this->fieldsBuilder = Builder::make($name);
76 | 
77 |         $this->fieldsBuilder->setParentContext($this);
78 |     }
79 | }
80 | 


--------------------------------------------------------------------------------
/src/Manifest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Log1x\AcfComposer;
  4 | 
  5 | use Exception;
  6 | use Illuminate\Support\Collection;
  7 | use Illuminate\Support\Facades\File;
  8 | use Illuminate\Support\Str;
  9 | 
 10 | class Manifest
 11 | {
 12 |     /**
 13 |      * The ACF Composer instance.
 14 |      */
 15 |     protected AcfComposer $composer;
 16 | 
 17 |     /**
 18 |      * The manifest collection.
 19 |      */
 20 |     protected Collection $manifest;
 21 | 
 22 |     /**
 23 |      * The block collection.
 24 |      */
 25 |     protected array $blocks = [];
 26 | 
 27 |     /**
 28 |      * The cache path.
 29 |      */
 30 |     protected string $path;
 31 | 
 32 |     /**
 33 |      * Create a new Manifest instance.
 34 |      */
 35 |     public function __construct(AcfComposer $composer)
 36 |     {
 37 |         $this->composer = $composer;
 38 | 
 39 |         $this->path = Str::finish(
 40 |             config('acf-composer.manifest', storage_path('framework/cache')),
 41 |             '/acf-composer'
 42 |         );
 43 | 
 44 |         $this->manifest = $this->exists()
 45 |             ? Collection::make(require $this->path())
 46 |             : Collection::make();
 47 |     }
 48 | 
 49 |     /**
 50 |      * Make a new instance of Manifest.
 51 |      */
 52 |     public static function make(AcfComposer $composer): self
 53 |     {
 54 |         return new static($composer);
 55 |     }
 56 | 
 57 |     /**
 58 |      * Retrieve the manifest path.
 59 |      */
 60 |     public function path(?string $filename = 'manifest.php'): string
 61 |     {
 62 |         return "{$this->path}/{$filename}";
 63 |     }
 64 | 
 65 |     /**
 66 |      * Determine if the manifest exists.
 67 |      */
 68 |     public function exists(?string $filename = null): bool
 69 |     {
 70 |         return file_exists($this->path($filename));
 71 |     }
 72 | 
 73 |     /**
 74 |      * Add the Composer to the manifest.
 75 |      */
 76 |     public function add(Composer $composer): bool
 77 |     {
 78 |         try {
 79 |             $this->manifest->put($composer::class, $composer->getFields(cache: false));
 80 | 
 81 |             if (is_a($composer, Block::class)) {
 82 |                 $this->blocks[$composer->jsonPath()] = $composer->toJson();
 83 |             }
 84 | 
 85 |             return true;
 86 |         } catch (Exception) {
 87 |             return false;
 88 |         }
 89 |     }
 90 | 
 91 |     /**
 92 |      * Retrieve the cached Composer from the manifest.
 93 |      */
 94 |     public function get(Composer $composer): array
 95 |     {
 96 |         return $this->manifest->get($composer::class);
 97 |     }
 98 | 
 99 |     /**
100 |      * Determine if the Composer is cached.
101 |      */
102 |     public function has(Composer $class): bool
103 |     {
104 |         return $this->manifest->has($class::class);
105 |     }
106 | 
107 |     /**
108 |      * Write the the manifest to disk.
109 |      */
110 |     public function write(): ?int
111 |     {
112 |         File::ensureDirectoryExists($this->path);
113 | 
114 |         $manifest = $this->toArray();
115 | 
116 |         return file_put_contents(
117 |             $this->path(),
118 |             '<?php return '.var_export($manifest, true).';'
119 |         ) !== false ? count($manifest) : null;
120 |     }
121 | 
122 |     /**
123 |      * Write the block JSON to disk.
124 |      */
125 |     public function writeBlocks(): int
126 |     {
127 |         if (! $this->blocks) {
128 |             return 0;
129 |         }
130 | 
131 |         $path = $this->path('blocks');
132 | 
133 |         foreach ($this->blocks as $path => $block) {
134 |             File::ensureDirectoryExists(dirname($path));
135 |             File::put($path, $block);
136 |         }
137 | 
138 |         return count($this->blocks);
139 |     }
140 | 
141 |     /**
142 |      * Delete the manifest from disk.
143 |      */
144 |     public function delete(): bool
145 |     {
146 |         return File::isDirectory($this->path)
147 |             ? File::deleteDirectory($this->path)
148 |             : false;
149 |     }
150 | 
151 |     /**
152 |      * Retrieve the manifest as an array.
153 |      */
154 |     public function toArray(): array
155 |     {
156 |         return $this->manifest->all();
157 |     }
158 | }
159 | 


--------------------------------------------------------------------------------
/src/Console/stubs/block.stub:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace DummyNamespace;
  4 | 
  5 | use Log1x\AcfComposer\Block;
  6 | use Log1x\AcfComposer\Builder;
  7 | 
  8 | class DummyClass extends Block
  9 | {
 10 |     /**
 11 |      * The block name.
 12 |      *
 13 |      * @var string
 14 |      */
 15 |     public $name = 'DummyTitle';
 16 | 
 17 |     /**
 18 |      * The block description.
 19 |      *
 20 |      * @var string
 21 |      */
 22 |     public $description = 'DummyDescription';
 23 | 
 24 |     /**
 25 |      * The block category.
 26 |      *
 27 |      * @var string
 28 |      */
 29 |     public $category = 'DummyCategory';
 30 | 
 31 |     /**
 32 |      * The block icon.
 33 |      *
 34 |      * @var string|array
 35 |      */
 36 |     public $icon = 'editor-ul';
 37 | 
 38 |     /**
 39 |      * The block keywords.
 40 |      *
 41 |      * @var array
 42 |      */
 43 |     public $keywords = [];
 44 | 
 45 |     /**
 46 |      * The block post type allow list.
 47 |      *
 48 |      * @var array
 49 |      */
 50 |     public $post_types = [DummyPostTypes];
 51 | 
 52 |     /**
 53 |      * The parent block type allow list.
 54 |      *
 55 |      * @var array
 56 |      */
 57 |     public $parent = [];
 58 | 
 59 |     /**
 60 |      * The ancestor block type allow list.
 61 |      *
 62 |      * @var array
 63 |      */
 64 |     public $ancestor = [];
 65 | 
 66 |     /**
 67 |      * The default block mode.
 68 |      *
 69 |      * @var string
 70 |      */
 71 |     public $mode = 'preview';
 72 | 
 73 |     /**
 74 |      * The default block alignment.
 75 |      *
 76 |      * @var string
 77 |      */
 78 |     public $align = '';
 79 | 
 80 |     /**
 81 |      * The default block text alignment.
 82 |      *
 83 |      * @var string
 84 |      */
 85 |     public $align_text = '';
 86 | 
 87 |     /**
 88 |      * The default block content alignment.
 89 |      *
 90 |      * @var string
 91 |      */
 92 |     public $align_content = '';
 93 | 
 94 |     /**
 95 |      * The default block spacing.
 96 |      *
 97 |      * @var array
 98 |      */
 99 |     public $spacing = [
100 |         'padding' => null,
101 |         'margin' => null,
102 |     ];
103 | 
104 |     /**
105 |      * The supported block features.
106 |      *
107 |      * @var array
108 |      */
109 |     public $supports = [
110 |         DummySupports
111 |     ];
112 | 
113 |     /**
114 |      * The block styles.
115 |      *
116 |      * @var array
117 |      */
118 |     public $styles = ['light', 'dark'];
119 | 
120 |     /**
121 |      * The block preview example data.
122 |      *
123 |      * @var array
124 |      */
125 |     public $example = [
126 |         'items' => [
127 |             ['item' => 'Item one'],
128 |             ['item' => 'Item two'],
129 |             ['item' => 'Item three'],
130 |         ],
131 |     ];
132 | 
133 |     /**
134 |      * The block template.
135 |      *
136 |      * @var array
137 |      */
138 |     public $template = [
139 |         'core/heading' => ['placeholder' => 'Hello World'],
140 |         'core/paragraph' => ['placeholder' => 'Welcome to the DummyTitle block.'],
141 |     ];
142 | 
143 |     /**
144 |      * Data to be passed to the block before rendering.
145 |      */
146 |     public function with(): array
147 |     {
148 |         return [
149 |             'items' => $this->items(),
150 |         ];
151 |     }
152 | 
153 |     /**
154 |      * The block field group.
155 |      */
156 |     public function fields(): array
157 |     {
158 |         $fields = Builder::make('DummySnake');
159 | 
160 |         $fields
161 |             ->addRepeater('items')
162 |                 ->addText('item')
163 |             ->endRepeater();
164 | 
165 |         return $fields->build();
166 |     }
167 | 
168 |     /**
169 |      * Retrieve the items.
170 |      *
171 |      * @return array
172 |      */
173 |     public function items()
174 |     {
175 |         return get_field('items') ?: $this->example['items'];
176 |     }
177 | 
178 |     /**
179 |      * Assets enqueued with 'enqueue_block_assets' when rendering the block.
180 |      *
181 |      * @link https://developer.wordpress.org/block-editor/how-to-guides/enqueueing-assets-in-the-editor/#editor-content-scripts-and-styles
182 |      */
183 |     public function assets(array $block): void
184 |     {
185 |         //
186 |     }
187 | }
188 | 


--------------------------------------------------------------------------------
/src/Options.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Log1x\AcfComposer;
  4 | 
  5 | use Illuminate\Support\Arr;
  6 | use Illuminate\Support\Str;
  7 | 
  8 | abstract class Options extends Composer
  9 | {
 10 |     /**
 11 |      * The option page menu name.
 12 |      *
 13 |      * @var string
 14 |      */
 15 |     public $name = '';
 16 | 
 17 |     /**
 18 |      * The option page menu slug.
 19 |      *
 20 |      * @var string
 21 |      */
 22 |     public $slug = '';
 23 | 
 24 |     /**
 25 |      * The option page document title.
 26 |      *
 27 |      * @var string
 28 |      */
 29 |     public $title = '';
 30 | 
 31 |     /**
 32 |      * The option page permission capability.
 33 |      *
 34 |      * @var string
 35 |      */
 36 |     public $capability = 'edit_theme_options';
 37 | 
 38 |     /**
 39 |      * The option page menu position.
 40 |      *
 41 |      * @var int
 42 |      */
 43 |     public $position = PHP_INT_MAX;
 44 | 
 45 |     /**
 46 |      * The option page visibility in the admin menu.
 47 |      *
 48 |      * @var bool
 49 |      */
 50 |     public $menu = true;
 51 | 
 52 |     /**
 53 |      * The slug of another admin page to be used as a parent.
 54 |      *
 55 |      * @var string
 56 |      */
 57 |     public $parent = null;
 58 | 
 59 |     /**
 60 |      * The option page menu icon.
 61 |      *
 62 |      * @var string
 63 |      */
 64 |     public $icon = null;
 65 | 
 66 |     /**
 67 |      * Redirect to the first child page if one exists.
 68 |      *
 69 |      * @var bool
 70 |      */
 71 |     public $redirect = false;
 72 | 
 73 |     /**
 74 |      * The post ID to save and load values from.
 75 |      *
 76 |      * @var string|int
 77 |      */
 78 |     public $post = 'options';
 79 | 
 80 |     /**
 81 |      * The option page autoload setting.
 82 |      *
 83 |      * @var bool
 84 |      */
 85 |     public $autoload = true;
 86 | 
 87 |     /**
 88 |      * The additional option page settings.
 89 |      *
 90 |      * @var array
 91 |      */
 92 |     public $settings = [];
 93 | 
 94 |     /**
 95 |      * Localized text displayed on the submit button.
 96 |      *
 97 |      * @return string
 98 |      */
 99 |     public function updateButton()
100 |     {
101 |         return __('Update', 'acf');
102 |     }
103 | 
104 |     /**
105 |      * Localized text displayed after form submission.
106 |      *
107 |      * @return string
108 |      */
109 |     public function updatedMessage()
110 |     {
111 |         return __('Options Updated', 'acf');
112 |     }
113 | 
114 |     /**
115 |      * Compose and register the defined ACF field groups.
116 |      *
117 |      * @return mixed
118 |      */
119 |     public function compose()
120 |     {
121 |         if (empty($this->name)) {
122 |             return;
123 |         }
124 | 
125 |         if (empty($this->slug)) {
126 |             $this->slug = Str::slug($this->name);
127 |         }
128 | 
129 |         if (empty($this->title)) {
130 |             $this->title = $this->name;
131 |         }
132 | 
133 |         if (! Arr::has($this->fields, 'location.0.0')) {
134 |             Arr::set($this->fields, 'location.0.0', [
135 |                 'param' => 'options_page',
136 |                 'operator' => '==',
137 |                 'value' => $this->slug,
138 |             ]);
139 |         }
140 | 
141 |         $this->register(function () {
142 |             if (! $this->menu) {
143 |                 return;
144 |             }
145 | 
146 |             acf_add_options_page(
147 |                 array_merge([
148 |                     'menu_title' => $this->name,
149 |                     'menu_slug' => $this->slug,
150 |                     'page_title' => $this->title,
151 |                     'capability' => $this->capability,
152 |                     'position' => $this->position,
153 |                     'parent_slug' => $this->parent,
154 |                     'icon_url' => $this->icon,
155 |                     'redirect' => $this->redirect,
156 |                     'post_id' => $this->post,
157 |                     'autoload' => $this->autoload,
158 |                     'update_button' => $this->updateButton(),
159 |                     'updated_message' => $this->updatedMessage(),
160 |                 ], $this->settings)
161 |             );
162 |         });
163 | 
164 |         return $this;
165 |     }
166 | }
167 | 


--------------------------------------------------------------------------------
/src/Console/stubs/block.localized.stub:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace DummyNamespace;
  4 | 
  5 | use Log1x\AcfComposer\Block;
  6 | use Log1x\AcfComposer\Builder;
  7 | 
  8 | class DummyClass extends Block
  9 | {
 10 |     /**
 11 |      * The block slug.
 12 |      *
 13 |      * @var string
 14 |      */
 15 |     public $slug = 'DummySnake';
 16 | 
 17 |     /**
 18 |      * The block category.
 19 |      *
 20 |      * @var string
 21 |      */
 22 |     public $category = 'DummyCategory';
 23 | 
 24 |     /**
 25 |      * The block icon.
 26 |      *
 27 |      * @var string|array
 28 |      */
 29 |     public $icon = 'editor-ul';
 30 | 
 31 |     /**
 32 |      * The block keywords.
 33 |      *
 34 |      * @var array
 35 |      */
 36 |     public $keywords = [];
 37 | 
 38 |     /**
 39 |      * The block post type allow list.
 40 |      *
 41 |      * @var array
 42 |      */
 43 |     public $post_types = [DummyPostTypes];
 44 | 
 45 |     /**
 46 |      * The parent block type allow list.
 47 |      *
 48 |      * @var array
 49 |      */
 50 |     public $parent = [];
 51 | 
 52 |     /**
 53 |      * The ancestor block type allow list.
 54 |      *
 55 |      * @var array
 56 |      */
 57 |     public $ancestor = [];
 58 | 
 59 |     /**
 60 |      * The default block mode.
 61 |      *
 62 |      * @var string
 63 |      */
 64 |     public $mode = 'preview';
 65 | 
 66 |     /**
 67 |      * The default block alignment.
 68 |      *
 69 |      * @var string
 70 |      */
 71 |     public $align = '';
 72 | 
 73 |     /**
 74 |      * The default block text alignment.
 75 |      *
 76 |      * @var string
 77 |      */
 78 |     public $align_text = '';
 79 | 
 80 |     /**
 81 |      * The default block content alignment.
 82 |      *
 83 |      * @var string
 84 |      */
 85 |     public $align_content = '';
 86 | 
 87 |     /**
 88 |      * The supported block features.
 89 |      *
 90 |      * @var array
 91 |      */
 92 |     public $supports = [
 93 |         DummySupports
 94 |     ];
 95 | 
 96 |     /**
 97 |      * The block styles.
 98 |      *
 99 |      * @var array
100 |      */
101 |     public $styles = ['light', 'dark'];
102 | 
103 |     /**
104 |      * The block preview example data.
105 |      *
106 |      * @var array
107 |      */
108 |     public $example = [
109 |         'items' => [
110 |             ['item' => 'Item one'],
111 |             ['item' => 'Item two'],
112 |             ['item' => 'Item three'],
113 |         ],
114 |     ];
115 | 
116 |     /**
117 |      * The block template.
118 |      *
119 |      * @var array
120 |      */
121 |     public $template = [
122 |         'core/heading' => ['placeholder' => 'Hello World'],
123 |         'core/paragraph' => ['placeholder' => 'Welcome to the DummyTitle block.'],
124 |     ];
125 | 
126 |     /**
127 |      * The block name.
128 |      */
129 |     public function getName(): string
130 |     {
131 |         return __('DummyTitle', 'sage');
132 |     }
133 | 
134 |     /**
135 |      * The block description.
136 |      */
137 |     public function getDescription(): string
138 |     {
139 |         return __('DummyDescription', 'sage');
140 |     }
141 | 
142 |     /**
143 |      * Data to be passed to the block before rendering.
144 |      */
145 |     public function with(): array
146 |     {
147 |         return [
148 |             'items' => $this->items(),
149 |         ];
150 |     }
151 | 
152 |     /**
153 |      * The block field group.
154 |      */
155 |     public function fields(): array
156 |     {
157 |         $fields = Builder::make('DummySnake');
158 | 
159 |         $fields
160 |             ->addRepeater('items')
161 |                 ->addText('item')
162 |             ->endRepeater();
163 | 
164 |         return $fields->build();
165 |     }
166 | 
167 |     /**
168 |      * Retrieve the items.
169 |      *
170 |      * @return array
171 |      */
172 |     public function items()
173 |     {
174 |         return get_field('items') ?: $this->example['items'];
175 |     }
176 | 
177 |     /**
178 |      * Assets enqueued with 'enqueue_block_assets' when rendering the block.
179 |      *
180 |      * @link https://developer.wordpress.org/block-editor/how-to-guides/enqueueing-assets-in-the-editor/#editor-content-scripts-and-styles
181 |      */
182 |     public function assets(array $block): void
183 |     {
184 |         //
185 |     }
186 | }
187 | 


--------------------------------------------------------------------------------
/src/Console/UpgradeCommand.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Log1x\AcfComposer\Console;
  4 | 
  5 | use Illuminate\Console\Command;
  6 | use Illuminate\Support\Str;
  7 | use Log1x\AcfComposer\AcfComposer;
  8 | use Log1x\AcfComposer\Concerns\HasCollection;
  9 | 
 10 | class UpgradeCommand extends Command
 11 | {
 12 |     use HasCollection;
 13 | 
 14 |     /**
 15 |      * The name and signature of the console command.
 16 |      *
 17 |      * @var string
 18 |      */
 19 |     protected $signature = 'acf:upgrade';
 20 | 
 21 |     /**
 22 |      * The console command description.
 23 |      *
 24 |      * @var string
 25 |      */
 26 |     protected $description = 'Simple upgrade helper to migrate from v2 to v3';
 27 | 
 28 |     /**
 29 |      * The ACF Composer instance.
 30 |      */
 31 |     protected AcfComposer $composer;
 32 | 
 33 |     /**
 34 |      * The replacement patterns.
 35 |      */
 36 |     protected array $replacements;
 37 | 
 38 |     /**
 39 |      * Execute the console command.
 40 |      */
 41 |     public function handle()
 42 |     {
 43 |         $this->composer = $this->laravel['AcfComposer'];
 44 | 
 45 |         $this->replacements = [
 46 |             'use StoutLogic\\AcfBuilder\\FieldsBuilder;' => 'use Log1x\\AcfComposer\\Builder;',
 47 |             'new FieldsBuilder(' => 'Builder::make(',
 48 |             'public function assets($block)' => 'public function assets(array $block): void',
 49 |             'public function enqueue($block)' => 'public function assets(array $block): void',
 50 |             'public function enqueue($block = [])' => 'public function assets(array $block): void',
 51 |             'public function enqueue()' => 'public function assets(array $block): void',
 52 |             '/->addFields\(\$this->get\((.*?)\)\)/' => fn ($match) => "->addPartial({$match[1]})",
 53 |             '/->addLayout\(\$this->get\((.*?)\)\)/' => fn ($match) => "->addLayout({$match[1]})",
 54 |         ];
 55 | 
 56 |         $this->components->info('Checking for outdated <fg=blue>ACF Composer</> classes...');
 57 | 
 58 |         $classes = $this->collect($this->composer->paths())->flatMap(fn ($classes, $path) => $this->collect($classes)
 59 |             ->map(fn ($class) => Str::of($class)->replace('\\', '/')->after('/')->start($path.'/')->finish('.php')->toString())
 60 |             ->all()
 61 |         )
 62 |             ->filter(fn ($class) => file_exists($class))
 63 |             ->mapWithKeys(fn ($class) => [$class => file_get_contents($class)])
 64 |             ->filter(fn ($class) => Str::contains($class, array_keys($this->replacements)));
 65 | 
 66 |         if ($classes->isEmpty()) {
 67 |             return $this->components->info('No outdated <fg=blue>ACF Composer</> classes found.');
 68 |         }
 69 | 
 70 |         $files = $classes
 71 |             ->keys()
 72 |             ->map(fn ($class) => basename($class, '.php'))
 73 |             ->map(fn ($class) => "<fg=blue>{$class}</>")
 74 |             ->all();
 75 | 
 76 |         $this->components->bulletList($files);
 77 | 
 78 |         if (! $this->components->confirm("Found <fg=blue>{$classes->count()}</> ACF Composer classes to upgrade. Do you wish to <fg=blue>continue</>?", true)) {
 79 |             return $this->components->error('The ACF Composer upgrade has been <fg=red>cancelled</>.');
 80 |         }
 81 | 
 82 |         $classes->each(function ($class, $path) {
 83 |             $name = basename($path, '.php');
 84 | 
 85 |             $this->components->task(
 86 |                 "Upgrading the <fg=blue>{$name}</> class",
 87 |                 fn () => $this->handleUpgrade($path, $class)
 88 |             );
 89 |         });
 90 | 
 91 |         $this->newLine();
 92 | 
 93 |         $this->components->info("Successfully upgraded <fg=blue>{$classes->count()}</> ACF Composer classes.");
 94 |     }
 95 | 
 96 |     /**
 97 |      * Upgrade the ACF Composer class file.
 98 |      */
 99 |     protected function handleUpgrade(string $path, string $class): bool
100 |     {
101 |         foreach ($this->replacements as $pattern => $replacement) {
102 |             $class = is_callable($replacement) ?
103 |                 preg_replace_callback($pattern, $replacement, $class) :
104 |                 str_replace($pattern, $replacement, $class);
105 |         }
106 | 
107 |         return file_put_contents($path, $class) !== false;
108 |     }
109 | }
110 | 


--------------------------------------------------------------------------------
/src/Builder/FlexibleContentBuilder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Log1x\AcfComposer\Builder;
 4 | 
 5 | use Log1x\AcfComposer\Builder;
 6 | use Log1x\AcfComposer\Partial;
 7 | use ReflectionClass;
 8 | use StoutLogic\AcfBuilder\FieldsBuilder;
 9 | use StoutLogic\AcfBuilder\FlexibleContentBuilder as FieldBuilder;
10 | 
11 | /**
12 |  * @method AccordionBuilder addAccordion(string $label, array $args = [])
13 |  * @method Builder addLayout(string|FieldsBuilder $layout, array $args = [])
14 |  * @method Builder endFlexibleContent()
15 |  * @method Builder endGroup()
16 |  * @method Builder endRepeater()
17 |  * @method Builder modifyField(string $name, array|\Closure $modify)
18 |  * @method ChoiceFieldBuilder addButtonGroup(string $name, array $args = [])
19 |  * @method ChoiceFieldBuilder addCheckbox(string $name, array $args = [])
20 |  * @method ChoiceFieldBuilder addChoiceField(string $name, string $type, array $args = [])
21 |  * @method ChoiceFieldBuilder addRadio(string $name, array $args = [])
22 |  * @method ChoiceFieldBuilder addSelect(string $name, array $args = [])
23 |  * @method FieldBuilder addColorPicker(string $name, array $args = [])
24 |  * @method FieldBuilder addDatePicker(string $name, array $args = [])
25 |  * @method FieldBuilder addDateTimePicker(string $name, array $args = [])
26 |  * @method FieldBuilder addEmail(string $name, array $args = [])
27 |  * @method FieldBuilder addField(string $name, string $type, array $args = [])
28 |  * @method FieldBuilder addFields(FieldsBuilder|array $fields)
29 |  * @method FieldBuilder addFile(string $name, array $args = [])
30 |  * @method FieldBuilder addGallery(string $name, array $args = [])
31 |  * @method FieldBuilder addGoogleMap(string $name, array $args = [])
32 |  * @method FieldBuilder addImage(string $name, array $args = [])
33 |  * @method FieldBuilder addLink(string $name, array $args = [])
34 |  * @method FieldBuilder addMessage(string $label, string $message, array $args = [])
35 |  * @method FieldBuilder addNumber(string $name, array $args = [])
36 |  * @method FieldBuilder addOembed(string $name, array $args = [])
37 |  * @method FieldBuilder addPageLink(string $name, array $args = [])
38 |  * @method FieldBuilder addPartial(string $partial, array $args = [])
39 |  * @method FieldBuilder addPartials(array $partials)
40 |  * @method FieldBuilder addPassword(string $name, array $args = [])
41 |  * @method FieldBuilder addPostObject(string $name, array $args = [])
42 |  * @method FieldBuilder addRange(string $name, array $args = [])
43 |  * @method FieldBuilder addRelationship(string $name, array $args = [])
44 |  * @method FieldBuilder addTaxonomy(string $name, array $args = [])
45 |  * @method FieldBuilder addText(string $name, array $args = [])
46 |  * @method FieldBuilder addTextarea(string $name, array $args = [])
47 |  * @method FieldBuilder addTimePicker(string $name, array $args = [])
48 |  * @method FieldBuilder addTrueFalse(string $name, array $args = [])
49 |  * @method FieldBuilder addUrl(string $name, array $args = [])
50 |  * @method FieldBuilder addUser(string $name, array $args = [])
51 |  * @method FieldBuilder addWysiwyg(string $name, array $args = [])
52 |  * @method FlexibleContentBuilder addFlexibleContent(string $name, array $args = [])
53 |  * @method GroupBuilder addGroup(string $name, array $args = [])
54 |  * @method GroupBuilder end()
55 |  * @method LocationBuilder setLocation(string $param, string $operator, string $value)
56 |  * @method RepeaterBuilder addRepeater(string $name, array $args = [])
57 |  * @method TabBuilder addTab(string $label, array $args = [])
58 |  */
59 | class FlexibleContentBuilder extends FieldBuilder
60 | {
61 |     /**
62 |      * Add a layout to the Flexible Content field.
63 |      *
64 |      * @param  string|FieldsBuilder  $layout
65 |      * @param  array  $args
66 |      * @return \Log1x\AcfComposer\Builder
67 |      */
68 |     public function addLayout($layout, $args = [])
69 |     {
70 |         if (
71 |             is_string($layout) &&
72 |             is_subclass_of($layout, Partial::class) &&
73 |             ! (new ReflectionClass($layout))->isAbstract()
74 |         ) {
75 |             $layout = $layout::make($this->composer())->compose();
76 |         }
77 | 
78 |         $layout = is_a($layout, FieldsBuilder::class)
79 |             ? clone $layout
80 |             : Builder::make($layout, $args);
81 | 
82 |         $layout = $this->initializeLayout($layout, $args);
83 | 
84 |         $this->pushLayout($layout);
85 | 
86 |         return $layout;
87 |     }
88 | }
89 | 


--------------------------------------------------------------------------------
/src/Widget.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Log1x\AcfComposer;
  4 | 
  5 | use Illuminate\Support\Arr;
  6 | use Illuminate\Support\Str;
  7 | use Log1x\AcfComposer\Concerns\InteractsWithBlade;
  8 | use Log1x\AcfComposer\Contracts\Widget as WidgetContract;
  9 | use WP_Widget;
 10 | 
 11 | abstract class Widget extends Composer implements WidgetContract
 12 | {
 13 |     use InteractsWithBlade;
 14 | 
 15 |     /**
 16 |      * The widget instance.
 17 |      *
 18 |      * @var object
 19 |      */
 20 |     public $widget;
 21 | 
 22 |     /**
 23 |      * The widget ID.
 24 |      *
 25 |      * @var string
 26 |      */
 27 |     public $id;
 28 | 
 29 |     /**
 30 |      * The name of the widget.
 31 |      *
 32 |      * @var string
 33 |      */
 34 |     public $name = '';
 35 | 
 36 |     /**
 37 |      * The widget slug.
 38 |      *
 39 |      * @var string
 40 |      */
 41 |     public $slug = '';
 42 | 
 43 |     /**
 44 |      * The widget description.
 45 |      *
 46 |      * @var string
 47 |      */
 48 |     public $description = '';
 49 | 
 50 |     /**
 51 |      * Compose and register the defined ACF field groups.
 52 |      *
 53 |      * @return mixed
 54 |      */
 55 |     public function compose()
 56 |     {
 57 |         if (empty($this->fields) || empty($this->name)) {
 58 |             return;
 59 |         }
 60 | 
 61 |         if (empty($this->slug)) {
 62 |             $this->slug = Str::slug($this->name);
 63 |         }
 64 | 
 65 |         if (! Arr::has($this->fields, 'location.0.0')) {
 66 |             Arr::set($this->fields, 'location.0.0', [
 67 |                 'param' => 'widget',
 68 |                 'operator' => '==',
 69 |                 'value' => $this->slug,
 70 |             ]);
 71 |         }
 72 | 
 73 |         $this->register(function () {
 74 |             $this->widget = (object) $this->collect(
 75 |                 Arr::get($GLOBALS, 'wp_registered_widgets')
 76 |             )->filter(fn ($value) => $value['name'] === $this->name)->pop();
 77 |         });
 78 | 
 79 |         add_filter('widgets_init', function () {
 80 |             register_widget($this->widget());
 81 |         }, 20);
 82 | 
 83 |         return $this;
 84 |     }
 85 | 
 86 |     /**
 87 |      * Determine if the widget should be displayed.
 88 |      */
 89 |     public function show(): bool
 90 |     {
 91 |         return true;
 92 |     }
 93 | 
 94 |     /**
 95 |      * Create a new WP_Widget instance.
 96 |      */
 97 |     protected function widget(): WP_Widget
 98 |     {
 99 |         return new class($this) extends WP_Widget
100 |         {
101 |             /**
102 |              * Create a new WP_Widget instance.
103 |              */
104 |             public function __construct(public Widget $composer)
105 |             {
106 |                 parent::__construct(
107 |                     $this->composer->slug,
108 |                     $this->composer->name,
109 |                     ['description' => $this->composer->description]
110 |                 );
111 |             }
112 | 
113 |             /**
114 |              * Render the widget.
115 |              *
116 |              * @param  array  $args
117 |              * @param  array  $instance
118 |              * @return void
119 |              */
120 |             public function widget($args, $instance)
121 |             {
122 |                 $this->composer->id = $this->composer->widget->id = Str::start($args['widget_id'], 'widget_');
123 | 
124 |                 if (! $this->composer->show()) {
125 |                     return;
126 |                 }
127 | 
128 |                 echo Arr::get($args, 'before_widget');
129 | 
130 |                 if (! empty($this->composer->title())) {
131 |                     echo $this->composer->collect([
132 |                         Arr::get($args, 'before_title'),
133 |                         $this->composer->title(),
134 |                         Arr::get($args, 'after_title'),
135 |                     ])->implode(PHP_EOL);
136 |                 }
137 | 
138 |                 echo $this->composer->view(
139 |                     Str::finish('widgets.', $this->composer->slug),
140 |                     ['widget' => $this->composer]
141 |                 );
142 | 
143 |                 echo Arr::get($args, 'after_widget');
144 |             }
145 | 
146 |             /**
147 |              * Output the widget settings update form.
148 |              * This is intentionally blank due to it being set by ACF.
149 |              *
150 |              * @param  array  $instance
151 |              * @return void
152 |              */
153 |             public function form($instance)
154 |             {
155 |                 //
156 |             }
157 |         };
158 |     }
159 | }
160 | 


--------------------------------------------------------------------------------
/src/Composer.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Log1x\AcfComposer;
  4 | 
  5 | use Illuminate\Support\Collection;
  6 | use Illuminate\Support\Str;
  7 | use Log1x\AcfComposer\Concerns\HasCollection;
  8 | use Log1x\AcfComposer\Concerns\InteractsWithPartial;
  9 | use Log1x\AcfComposer\Contracts\Composer as ComposerContract;
 10 | use Log1x\AcfComposer\Exceptions\InvalidFieldsException;
 11 | use Roots\Acorn\Application;
 12 | use StoutLogic\AcfBuilder\FieldsBuilder;
 13 | 
 14 | abstract class Composer implements ComposerContract
 15 | {
 16 |     use HasCollection, InteractsWithPartial;
 17 | 
 18 |     /**
 19 |      * The application instance.
 20 |      */
 21 |     protected Application $app;
 22 | 
 23 |     /**
 24 |      * The field keys.
 25 |      */
 26 |     protected array $keys = ['fields', 'sub_fields', 'layouts'];
 27 | 
 28 |     /**
 29 |      * The field groups.
 30 |      */
 31 |     protected array $fields = [];
 32 | 
 33 |     /**
 34 |      * The default field settings.
 35 |      */
 36 |     protected Collection|array $defaults = [];
 37 | 
 38 |     /**
 39 |      * Create a new Composer instance.
 40 |      */
 41 |     public function __construct(protected AcfComposer $composer)
 42 |     {
 43 |         $this->app = $this->composer->app;
 44 | 
 45 |         $this->defaults = $this->collect($this->app->config->get('acf.defaults'))
 46 |             ->merge($this->defaults)
 47 |             ->mapWithKeys(fn ($value, $key) => [Str::snake($key) => $value]);
 48 | 
 49 |         $this->fields = $this->getFields();
 50 |     }
 51 | 
 52 |     /**
 53 |      * Make a new instance of the Composer.
 54 |      */
 55 |     public static function make(AcfComposer $composer): self
 56 |     {
 57 |         return new static($composer);
 58 |     }
 59 | 
 60 |     /**
 61 |      * Handle the Composer instance.
 62 |      */
 63 |     public function handle(): self
 64 |     {
 65 |         $this->call('beforeRegister');
 66 | 
 67 |         $this->compose();
 68 | 
 69 |         $this->call('afterRegister');
 70 | 
 71 |         return $this;
 72 |     }
 73 | 
 74 |     /**
 75 |      * Call a method using the application container.
 76 |      */
 77 |     protected function call(string $hook, array $args = []): mixed
 78 |     {
 79 |         if (! method_exists($this, $hook)) {
 80 |             return null;
 81 |         }
 82 | 
 83 |         return $this->app->call([$this, $hook], [
 84 |             'args' => $args,
 85 |         ]);
 86 |     }
 87 | 
 88 |     /**
 89 |      * Register the field group with Advanced Custom Fields.
 90 |      */
 91 |     protected function register(?callable $callback = null): void
 92 |     {
 93 |         if (blank($this->fields)) {
 94 |             return;
 95 |         }
 96 | 
 97 |         if ($callback) {
 98 |             $callback();
 99 |         }
100 | 
101 |         acf_add_local_field_group(
102 |             $this->build($this->fields)
103 |         );
104 |     }
105 | 
106 |     /**
107 |      * Retrieve the field group fields.
108 |      */
109 |     public function getFields(bool $cache = true): array
110 |     {
111 |         if ($this->fields && $cache) {
112 |             return $this->fields;
113 |         }
114 | 
115 |         if ($cache && $this->composer->manifest()->has($this)) {
116 |             return $this->composer->manifest()->get($this);
117 |         }
118 | 
119 |         $fields = $this->resolveFields();
120 | 
121 |         $fields = is_a($fields, FieldsBuilder::class)
122 |             ? $fields->build()
123 |             : $fields;
124 | 
125 |         if (! is_array($fields)) {
126 |             throw new InvalidFieldsException;
127 |         }
128 | 
129 |         if ($this->defaults->has('field_group')) {
130 |             $fields = array_merge($this->defaults->get('field_group'), $fields);
131 |         }
132 | 
133 |         return $fields;
134 |     }
135 | 
136 |     /**
137 |      * Resolve the fields from the Composer with the container.
138 |      */
139 |     public function resolveFields(array $args = []): mixed
140 |     {
141 |         return $this->call('fields', $args) ?? [];
142 |     }
143 | 
144 |     /**
145 |      * Build the field group with the default field type settings.
146 |      */
147 |     public function build(array $fields = []): array
148 |     {
149 |         return $this->collect($fields)->map(function ($value, $key) {
150 |             if (
151 |                 ! in_array($key, $this->keys) ||
152 |                 ($key === 'type' && ! $this->defaults->has($value))
153 |             ) {
154 |                 return $value;
155 |             }
156 | 
157 |             return array_map(function ($field) {
158 |                 foreach ($field as $key => $value) {
159 |                     if (in_array($key, $this->keys)) {
160 |                         return $this->build($field);
161 |                     }
162 | 
163 |                     if ($key === 'type' && $this->defaults->has($value)) {
164 |                         $field = array_merge($this->defaults->get($field['type'], []), $field);
165 |                     }
166 |                 }
167 | 
168 |                 return $field;
169 |             }, $value);
170 |         })->all();
171 |     }
172 | }
173 | 


--------------------------------------------------------------------------------
/src/Console/BlockMakeCommand.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Log1x\AcfComposer\Console;
  4 | 
  5 | use Illuminate\Support\Str;
  6 | 
  7 | use function Laravel\Prompts\multiselect;
  8 | use function Laravel\Prompts\select;
  9 | use function Laravel\Prompts\text;
 10 | 
 11 | class BlockMakeCommand extends MakeCommand
 12 | {
 13 |     /**
 14 |      * The console command signature.
 15 |      *
 16 |      * @var string
 17 |      */
 18 |     protected $signature = 'acf:block {name* : The name of the block}
 19 |                             {--localize : Localize the block name and description}
 20 |                             {--force : Overwrite any existing files}';
 21 | 
 22 |     /**
 23 |      * The console command description.
 24 |      *
 25 |      * @var string
 26 |      */
 27 |     protected $description = 'Create a new ACF block type.';
 28 | 
 29 |     /**
 30 |      * The type of class being generated.
 31 |      *
 32 |      * @var string
 33 |      */
 34 |     protected $type = 'Block';
 35 | 
 36 |     /**
 37 |      * The view stub used when generated.
 38 |      *
 39 |      * @var string|bool
 40 |      */
 41 |     protected $view = 'block';
 42 | 
 43 |     /**
 44 |      * The block supports array.
 45 |      */
 46 |     protected array $supports = [
 47 |         'align',
 48 |         'align_text',
 49 |         'align_content',
 50 |         'full_height',
 51 |         'anchor',
 52 |         'mode',
 53 |         'multiple',
 54 |         'jsx',
 55 |         'color' => ['background', 'text', 'gradients'],
 56 |         'spacing' => ['padding', 'margin'],
 57 |     ];
 58 | 
 59 |     /**
 60 |      * {@inheritdoc}
 61 |      */
 62 |     public function buildClass($name)
 63 |     {
 64 |         $stub = parent::buildClass($name);
 65 | 
 66 |         $name = Str::of($name)
 67 |             ->afterLast('\\')
 68 |             ->kebab()
 69 |             ->headline()
 70 |             ->replace('-', ' ');
 71 | 
 72 |         $description = "A beautiful {$name} block.";
 73 | 
 74 |         $description = text(
 75 |             label: 'Enter the block description',
 76 |             placeholder: $description,
 77 |         ) ?: $description;
 78 | 
 79 |         $categories = get_default_block_categories();
 80 | 
 81 |         $category = select(
 82 |             label: 'Select the block category',
 83 |             options: $this->collect($categories)->mapWithKeys(fn ($category) => [$category['slug'] => $category['title']]),
 84 |             default: 'common',
 85 |         );
 86 | 
 87 |         $postTypes = multiselect(
 88 |             label: 'Select the supported post types',
 89 |             options: $this->collect(
 90 |                 get_post_types(['public' => true])
 91 |             )->mapWithKeys(fn ($postType) => [$postType => Str::headline($postType)])->all(),
 92 |             hint: 'Leave empty to support all post types.',
 93 |         );
 94 | 
 95 |         $postTypes = $this->collect($postTypes)
 96 |             ->map(fn ($postType) => sprintf("'%s'", $postType))
 97 |             ->join(', ');
 98 | 
 99 |         $supports = multiselect(
100 |             label: 'Select the supported block features',
101 |             options: $this->getSupports(),
102 |             default: config('acf.generators.supports', []),
103 |             scroll: 8,
104 |         );
105 | 
106 |         $stub = str_replace(
107 |             ['DummySupports', 'DummyDescription', 'DummyCategory', 'DummyPostTypes'],
108 |             [$this->buildSupports($supports), $description, $category, $postTypes],
109 |             $stub
110 |         );
111 | 
112 |         return $stub;
113 |     }
114 | 
115 |     /**
116 |      * Build the block supports array.
117 |      */
118 |     protected function buildSupports(array $selected): string
119 |     {
120 |         return $this->collect($this->supports)->map(function ($value, $key) use ($selected) {
121 |             if (is_int($key)) {
122 |                 return sprintf("'%s' => %s,", $value, in_array($value, $selected) ? 'true' : 'false');
123 |             }
124 | 
125 |             $options = $this->collect($value)
126 |                 ->map(fn ($option) => sprintf(
127 |                     "%s'%s' => %s,",
128 |                     Str::repeat(' ', 12),
129 |                     $option,
130 |                     in_array($option, $selected) ? 'true' : 'false'
131 |                 ))
132 |                 ->join("\n");
133 | 
134 |             return sprintf("'%s' => [\n%s\n        ],", $key, $options);
135 |         })->join("\n        ");
136 |     }
137 | 
138 |     /**
139 |      * Retrieve the support options.
140 |      */
141 |     protected function getSupports(): array
142 |     {
143 |         return $this->collect($this->supports)
144 |             ->mapWithKeys(fn ($value, $key) => is_array($value)
145 |                 ? $this->collect($value)->mapWithKeys(fn ($option) => [$option => Str::of($option)->finish(" {$key}")->headline()->toString()])->all()
146 |                 : [$value => Str::headline($value)]
147 |             )->all();
148 |     }
149 | 
150 |     /**
151 |      * Get the stub file for the generator.
152 |      *
153 |      * @return string
154 |      */
155 |     protected function getStub()
156 |     {
157 |         if ($this->option('localize')) {
158 |             return $this->resolveStub('block.localized');
159 |         }
160 | 
161 |         return $this->resolveStub('block');
162 |     }
163 | }
164 | 


--------------------------------------------------------------------------------
/src/Console/UsageCommand.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Log1x\AcfComposer\Console;
  4 | 
  5 | use Illuminate\Console\Command;
  6 | use Illuminate\Support\Collection;
  7 | use Illuminate\Support\Str;
  8 | use Log1x\AcfComposer\Concerns\HasCollection;
  9 | 
 10 | use function Laravel\Prompts\search;
 11 | use function Laravel\Prompts\table;
 12 | 
 13 | class UsageCommand extends Command
 14 | {
 15 |     use HasCollection;
 16 | 
 17 |     /**
 18 |      * The name and signature of the console command.
 19 |      *
 20 |      * @var string
 21 |      */
 22 |     protected $signature = 'acf:usage {field? : The field type to show}';
 23 | 
 24 |     /**
 25 |      * The console command description.
 26 |      *
 27 |      * @var string
 28 |      */
 29 |     protected $description = 'Show the usage of a registered field type';
 30 | 
 31 |     /**
 32 |      * The registered field types.
 33 |      */
 34 |     protected Collection $types;
 35 | 
 36 |     /**
 37 |      * Execute the console command.
 38 |      */
 39 |     public function handle()
 40 |     {
 41 |         if (! function_exists('acf_get_field_types')) {
 42 |             return $this->components->error('Advanced Custom Fields must be installed and activated to use this command.');
 43 |         }
 44 | 
 45 |         $this->types = $this->types();
 46 | 
 47 |         $field = $this->argument('field') ?: search(
 48 |             label: "<fg=gray>Search</> <fg=blue>{$this->types->count()}</> <fg=gray>registered field types</>",
 49 |             options: fn (string $value) => $this->search($value)->all(),
 50 |             hint: '<fg=blue>*</> <fg=gray>indicates a custom field type</>',
 51 |             scroll: 8,
 52 |         );
 53 | 
 54 |         $type = $this->type($field);
 55 | 
 56 |         if (! $type) {
 57 |             return $this->components->error("The field type [<fg=red>{$field}</>] could not be found.");
 58 |         }
 59 | 
 60 |         $options = $this->collect([
 61 |             ...$type->defaults ?? [],
 62 |             ...$type->supports ?? [],
 63 |         ])->except('escaping_html');
 64 | 
 65 |         table(['<fg=blue>Label</>', '<fg=blue>Name</>', '<fg=blue>Category</>', '<fg=blue>Options #</>', '<fg=blue>Source</>'], [[
 66 |             $type->label,
 67 |             $type->name,
 68 |             Str::title($type->category),
 69 |             $options->count(),
 70 |             $type->source,
 71 |         ]]);
 72 | 
 73 |         $method = Str::of($type->name)
 74 |             ->studly()
 75 |             ->start('add')
 76 |             ->toString();
 77 | 
 78 |         $native = method_exists('Log1x\AcfComposer\Builder', $method) ? $method : null;
 79 | 
 80 |         $options = $this->collect($options)->map(fn ($value) => match (true) {
 81 |             is_string($value) => "'{$value}'",
 82 |             is_array($value) => '[]',
 83 |             is_bool($value) => $value ? 'true' : 'false',
 84 |             default => $value,
 85 |         })->map(fn ($value, $key) => "\t '<fg=blue>{$key}</>' => <fg=blue>{$value}</>,");
 86 | 
 87 |         $usage = view('acf-composer::field-usage', [
 88 |             'name' => $type->name,
 89 |             'label' => "{$type->label} Example",
 90 |             'options' => $options->implode("\n"),
 91 |             'native' => $native,
 92 |         ]);
 93 | 
 94 |         $usage = $this->collect(explode("\n", $usage))
 95 |             ->map(fn ($line) => rtrim(" {$line}"))
 96 |             ->filter()
 97 |             ->implode("\n");
 98 | 
 99 |         $this->line($usage);
100 |     }
101 | 
102 |     /**
103 |      * Search for a field type.
104 |      */
105 |     protected function search(?string $search = null): Collection
106 |     {
107 |         if (filled($search)) {
108 |             return $this->types
109 |                 ->filter(fn ($type) => Str::contains($type->label, $search, ignoreCase: true) || Str::contains($type->name, $search, ignoreCase: true))
110 |                 ->map(fn ($type) => $type->label)
111 |                 ->values();
112 |         }
113 | 
114 |         return $this->types->map(fn ($type) => $type->label);
115 |     }
116 | 
117 |     /**
118 |      * Retrieve a field type by label or name.
119 |      */
120 |     protected function type(string $field): ?object
121 |     {
122 |         $exactMatch = $this->types->first(fn ($type) => strcasecmp($type->label, $field) === 0 || strcasecmp($type->name, $field) === 0);
123 | 
124 |         if ($exactMatch) {
125 |             return $exactMatch;
126 |         }
127 | 
128 |         $matches = $this->types->filter(fn ($type) => strcasecmp($type->label, $field) === 0 || strcasecmp($type->name, $field) === 0
129 |             || Str::contains($type->label, $field, ignoreCase: true)
130 |             || Str::contains($type->name, $field, ignoreCase: true));
131 | 
132 |         if ($matches->isEmpty()) {
133 |             return null;
134 |         }
135 | 
136 |         if ($matches->count() === 1) {
137 |             return $matches->first();
138 |         }
139 | 
140 |         $selected = search(
141 |             label: "<fg=gray>Found</> <fg=blue>{$matches->count()}</> <fg=gray>registered field types Please choose one:</>",
142 |             options: fn () => $matches->pluck('label', 'name')->all(),
143 |             hint: '<fg=blue>*</> <fg=gray>indicates a custom field type</>',
144 |             scroll: 8,
145 |         );
146 | 
147 |         return $matches->firstWhere('name', $selected);
148 |     }
149 | 
150 |     /**
151 |      * Retrieve all registered field types.
152 |      */
153 |     protected function types(): Collection
154 |     {
155 |         return $this->collect(
156 |             acf_get_field_types()
157 |         )->map(function ($type) {
158 |             if (Str::startsWith($type->doc_url, 'https://www.advancedcustomfields.com')) {
159 |                 $type->source = 'Official';
160 | 
161 |                 return $type;
162 |             }
163 | 
164 |             $type->label = "{$type->label} <fg=blue>*</>";
165 |             $type->source = $this->source($type);
166 | 
167 |             return $type;
168 |         })->sortBy('label');
169 |     }
170 | 
171 |     /**
172 |      * Attempt to retrieve the field type source.
173 |      */
174 |     protected function source(object $type): string
175 |     {
176 |         $paths = [WPMU_PLUGIN_DIR, WP_PLUGIN_DIR];
177 | 
178 |         $plugin = (new \ReflectionClass($type))->getFileName();
179 | 
180 |         if (! Str::contains($plugin, $paths)) {
181 |             return 'Unknown';
182 |         }
183 | 
184 |         $source = Str::of($plugin)->replace($paths, '')
185 |             ->trim('/')
186 |             ->explode('/')
187 |             ->first();
188 | 
189 |         return Str::of($source)
190 |             ->headline()
191 |             ->replace('Acf', 'ACF');
192 |     }
193 | }
194 | 


--------------------------------------------------------------------------------
/src/Console/MakeCommand.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Log1x\AcfComposer\Console;
  4 | 
  5 | use Exception;
  6 | use Illuminate\Support\Str;
  7 | use Log1x\AcfComposer\Concerns\HasCollection;
  8 | use Roots\Acorn\Console\Commands\GeneratorCommand;
  9 | 
 10 | class MakeCommand extends GeneratorCommand
 11 | {
 12 |     use HasCollection;
 13 | 
 14 |     /**
 15 |      * The view stub used when generated.
 16 |      *
 17 |      * @var string|bool
 18 |      */
 19 |     protected $view = false;
 20 | 
 21 |     /**
 22 |      * The generated class path.
 23 |      *
 24 |      * @var string
 25 |      */
 26 |     protected $path;
 27 | 
 28 |     /**
 29 |      * Execute the console command.
 30 |      *
 31 |      * @return mixed
 32 |      */
 33 |     public function handle()
 34 |     {
 35 |         $this->name = $this->qualifyClass($this->getNameInput());
 36 |         $this->path = $this->getPath($this->name);
 37 |         $this->type = str_replace('/', ' ', $this->type);
 38 | 
 39 |         $this->createClass();
 40 |         $this->createView();
 41 |         $this->summary();
 42 |     }
 43 | 
 44 |     /**
 45 |      * Replace the namespace for the given stub.
 46 |      *
 47 |      * @param  string  $stub
 48 |      * @param  string  $name
 49 |      * @return $this
 50 |      */
 51 |     protected function replaceDummyStrings(&$stub, $name)
 52 |     {
 53 |         $searches = [
 54 |             ['DummyTitle', 'DummyCamel', 'DummySlug', 'DummySnake'],
 55 |             ['{{ DummyTitle }}', '{{ DummyCamel }}', '{{ DummySlug }}', '{{ DummySnake }}'],
 56 |             ['{{DummyTitle}}', '{{DummyCamel}}', '{{DummySlug}}', '{{DummySnake}}'],
 57 |         ];
 58 | 
 59 |         $name = Str::title(
 60 |             str_replace('-', ' ', Str::kebab(Str::afterLast($name, '\\')))
 61 |         );
 62 | 
 63 |         foreach ($searches as $search) {
 64 |             $stub = str_replace(
 65 |                 $search,
 66 |                 [$name, Str::camel($name), Str::kebab($name), Str::snake($name)],
 67 |                 $stub
 68 |             );
 69 |         }
 70 | 
 71 |         return $this;
 72 |     }
 73 | 
 74 |     /**
 75 |      * Build the class with the given name.
 76 |      *
 77 |      * @param  string  $name
 78 |      * @return string
 79 |      *
 80 |      * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
 81 |      */
 82 |     protected function buildClass($name)
 83 |     {
 84 |         $stub = $this->files->get($this->getStub());
 85 | 
 86 |         return $this
 87 |             ->replaceDummyStrings($stub, $name)
 88 |             ->replaceNamespace($stub, $name)
 89 |             ->replaceClass($stub, $name);
 90 |     }
 91 | 
 92 |     /**
 93 |      * Return the full view destination.
 94 |      *
 95 |      * @return string
 96 |      */
 97 |     public function getView()
 98 |     {
 99 |         return Str::finish($this->getViewPath(), $this->getViewName());
100 |     }
101 | 
102 |     /**
103 |      * Return the view destination filename.
104 |      *
105 |      * @return string
106 |      */
107 |     public function getViewName()
108 |     {
109 |         return Str::finish(
110 |             str_replace('.', '/', Str::slug(Str::snake($this->getNameInput()))),
111 |             '.blade.php'
112 |         );
113 |     }
114 | 
115 |     /**
116 |      * Return the view destination path.
117 |      *
118 |      * @return string
119 |      */
120 |     public function getViewPath()
121 |     {
122 |         return $this->getPaths().'/'.Str::slug(Str::plural($this->type)).'/';
123 |     }
124 | 
125 |     /**
126 |      * Get the view stub file for the generator.
127 |      *
128 |      * @return string
129 |      */
130 |     protected function getViewStub()
131 |     {
132 |         if (empty($this->view)) {
133 |             return;
134 |         }
135 | 
136 |         return $this->resolveStub("views/{$this->view}");
137 |     }
138 | 
139 |     /**
140 |      * Get the default namespace for the class.
141 |      *
142 |      * @param  string  $rootNamespace
143 |      * @return string
144 |      */
145 |     protected function getDefaultNamespace($rootNamespace)
146 |     {
147 |         return $rootNamespace.'\\'.Str::plural($this->type);
148 |     }
149 | 
150 |     /**
151 |      * Return the applications view path.
152 |      *
153 |      * @param  string  $name
154 |      * @return void
155 |      */
156 |     protected function getPaths()
157 |     {
158 |         $paths = $this->app['view.finder']->getPaths();
159 | 
160 |         if (count($paths) === 1) {
161 |             return head($paths);
162 |         }
163 | 
164 |         return $this->choice('Where do you want to create the view(s)?', $paths, head($paths));
165 |     }
166 | 
167 |     /**
168 |      * Return the Composer type.
169 |      *
170 |      * @return void
171 |      */
172 |     protected function getType()
173 |     {
174 |         return $this->collect(explode('\\', $this->type))->map(function ($value) {
175 |             return Str::singular(Str::slug($value));
176 |         })->implode(' ');
177 |     }
178 | 
179 |     /**
180 |      * Create a Composer class.
181 |      *
182 |      * @return void
183 |      */
184 |     protected function createClass()
185 |     {
186 |         if ($this->isReservedName($this->getNameInput())) {
187 |             throw new Exception('The name "'.$this->getNameInput().'" is reserved by PHP.');
188 |         }
189 | 
190 |         if (
191 |             (! $this->hasOption('force') ||
192 |             ! $this->option('force')) &&
193 |             $this->alreadyExists($this->getNameInput())
194 |         ) {
195 |             throw new Exception('File `'.$this->shortenPath($this->path).'` already exists.');
196 |         }
197 | 
198 |         $this->makeDirectory($this->path);
199 | 
200 |         $this->files->put($this->path, $this->sortImports($this->buildClass($this->name)));
201 |     }
202 | 
203 |     /**
204 |      * Create the Composer view.
205 |      *
206 |      * @return void
207 |      */
208 |     protected function createView()
209 |     {
210 |         if (
211 |             empty($this->getViewStub()) ||
212 |             (! $this->hasOption('force') ||
213 |             ! $this->option('force')) &&
214 |             $this->files->exists($this->getView())
215 |         ) {
216 |             return;
217 |         }
218 | 
219 |         if (! $this->files->exists($this->getViewPath())) {
220 |             $this->files->makeDirectory($this->getViewPath());
221 |         }
222 | 
223 |         $this->files->put($this->getView(), $this->files->get($this->getViewStub()));
224 |     }
225 | 
226 |     /**
227 |      * Return the block creation summary.
228 |      *
229 |      * @return void
230 |      */
231 |     protected function summary()
232 |     {
233 |         if (! Str::contains($this->type, ['Block', 'Widget'])) {
234 |             $this->newLine();
235 |         }
236 | 
237 |         $this->line("🎉 <fg=blue;options=bold>{$this->getNameInput()}</> {$this->getType()} successfully composed.");
238 |         $this->line("     ⮑  <fg=blue>{$this->shortenPath($this->path)}</>");
239 | 
240 |         if ($this->view) {
241 |             $this->line("     ⮑  <fg=blue>{$this->shortenPath($this->getView(), 4)}</>");
242 |         }
243 | 
244 |         if (! function_exists('acf')) {
245 |             $this->newLine();
246 | 
247 |             $this->components->warn('<fg=yellow>Advanced Custom Fields</> does not appear to be activated.');
248 |         }
249 |     }
250 | 
251 |     /**
252 |      * Returns a shortened path.
253 |      *
254 |      * @param  string  $path
255 |      * @param  int  $index
256 |      * @return string
257 |      */
258 |     protected function shortenPath($path, $index = 3)
259 |     {
260 |         return $this->collect(
261 |             explode('/', $path)
262 |         )->slice(-$index, $index)->implode('/');
263 |     }
264 | 
265 |     /**
266 |      * Get the stub file for the generator.
267 |      *
268 |      * @return string
269 |      */
270 |     protected function getStub()
271 |     {
272 |         //
273 |     }
274 | 
275 |     /**
276 |      * Get the resolved stub file path.
277 |      *
278 |      * @param  string  $name
279 |      * @return string
280 |      */
281 |     protected function resolveStub($name)
282 |     {
283 |         $path = '/'.$name.'.stub';
284 | 
285 |         return $this->files->exists($stubsPath = $this->app->basePath('stubs/acf-composer').$path)
286 |             ? $stubsPath
287 |             : __DIR__.'/stubs'.$path;
288 |     }
289 | }
290 | 


--------------------------------------------------------------------------------
/src/Builder.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Log1x\AcfComposer;
  4 | 
  5 | use Illuminate\Support\Str;
  6 | use InvalidArgumentException;
  7 | use Log1x\AcfComposer\Builder\AccordionBuilder;
  8 | use Log1x\AcfComposer\Builder\ChoiceFieldBuilder;
  9 | use Log1x\AcfComposer\Builder\FieldBuilder;
 10 | use Log1x\AcfComposer\Builder\FlexibleContentBuilder;
 11 | use Log1x\AcfComposer\Builder\GroupBuilder;
 12 | use Log1x\AcfComposer\Builder\RepeaterBuilder;
 13 | use Log1x\AcfComposer\Builder\TabBuilder;
 14 | use Log1x\AcfComposer\Concerns\HasCollection;
 15 | use ReflectionClass;
 16 | use StoutLogic\AcfBuilder\FieldsBuilder;
 17 | use StoutLogic\AcfBuilder\LocationBuilder;
 18 | 
 19 | /**
 20 |  * Builds configurations for an ACF Field.
 21 |  *
 22 |  * @method AccordionBuilder addAccordion(string $label, array $args = [])
 23 |  * @method Builder addLayout(string|FieldsBuilder $layout, array $args = [])
 24 |  * @method Builder endFlexibleContent()
 25 |  * @method Builder endGroup()
 26 |  * @method Builder endRepeater()
 27 |  * @method Builder modifyField(string $name, array|\Closure $modify)
 28 |  * @method ChoiceFieldBuilder addButtonGroup(string $name, array $args = [])
 29 |  * @method ChoiceFieldBuilder addCheckbox(string $name, array $args = [])
 30 |  * @method ChoiceFieldBuilder addChoiceField(string $name, string $type, array $args = [])
 31 |  * @method ChoiceFieldBuilder addRadio(string $name, array $args = [])
 32 |  * @method ChoiceFieldBuilder addSelect(string $name, array $args = [])
 33 |  * @method FieldBuilder addColorPicker(string $name, array $args = [])
 34 |  * @method FieldBuilder addDatePicker(string $name, array $args = [])
 35 |  * @method FieldBuilder addDateTimePicker(string $name, array $args = [])
 36 |  * @method FieldBuilder addEmail(string $name, array $args = [])
 37 |  * @method FieldBuilder addField(string $name, string $type, array $args = [])
 38 |  * @method FieldBuilder addFields(FieldsBuilder|array $fields)
 39 |  * @method FieldBuilder addFile(string $name, array $args = [])
 40 |  * @method FieldBuilder addGallery(string $name, array $args = [])
 41 |  * @method FieldBuilder addGoogleMap(string $name, array $args = [])
 42 |  * @method FieldBuilder addImage(string $name, array $args = [])
 43 |  * @method FieldBuilder addLink(string $name, array $args = [])
 44 |  * @method FieldBuilder addMessage(string $label, string $message, array $args = [])
 45 |  * @method FieldBuilder addNumber(string $name, array $args = [])
 46 |  * @method FieldBuilder addOembed(string $name, array $args = [])
 47 |  * @method FieldBuilder addPageLink(string $name, array $args = [])
 48 |  * @method FieldBuilder addPartial(string $partial, array $args = [])
 49 |  * @method FieldBuilder addPartials(array $partials)
 50 |  * @method FieldBuilder addPassword(string $name, array $args = [])
 51 |  * @method FieldBuilder addPostObject(string $name, array $args = [])
 52 |  * @method FieldBuilder addRange(string $name, array $args = [])
 53 |  * @method FieldBuilder addRelationship(string $name, array $args = [])
 54 |  * @method FieldBuilder addTaxonomy(string $name, array $args = [])
 55 |  * @method FieldBuilder addText(string $name, array $args = [])
 56 |  * @method FieldBuilder addTextarea(string $name, array $args = [])
 57 |  * @method FieldBuilder addTimePicker(string $name, array $args = [])
 58 |  * @method FieldBuilder addTrueFalse(string $name, array $args = [])
 59 |  * @method FieldBuilder addUrl(string $name, array $args = [])
 60 |  * @method FieldBuilder addUser(string $name, array $args = [])
 61 |  * @method FieldBuilder addWysiwyg(string $name, array $args = [])
 62 |  * @method FlexibleContentBuilder addFlexibleContent(string $name, array $args = [])
 63 |  * @method GroupBuilder addGroup(string $name, array $args = [])
 64 |  * @method GroupBuilder end()
 65 |  * @method LocationBuilder setLocation(string $param, string $operator, string $value)
 66 |  * @method RepeaterBuilder addRepeater(string $name, array $args = [])
 67 |  * @method TabBuilder addTab(string $label, array $args = [])
 68 |  */
 69 | class Builder extends FieldsBuilder
 70 | {
 71 |     use HasCollection;
 72 | 
 73 |     /**
 74 |      * The ACF Composer instance.
 75 |      */
 76 |     protected ?AcfComposer $composer = null;
 77 | 
 78 |     /**
 79 |      * The custom field types.
 80 |      */
 81 |     public ?array $types = null;
 82 | 
 83 |     /**
 84 |      * Make an instance of the Builder.
 85 |      */
 86 |     public static function make(string $name, array $config = []): self
 87 |     {
 88 |         return new static($name, $config);
 89 |     }
 90 | 
 91 |     /**
 92 |      * Add a partial to the field group.
 93 |      */
 94 |     public function addPartial(string $partial, array $args = []): self
 95 |     {
 96 |         if (
 97 |             is_string($partial) &&
 98 |             is_subclass_of($partial, Partial::class) &&
 99 |             ! (new ReflectionClass($partial))->isAbstract()
100 |         ) {
101 |             $partial = $partial::make($this->composer())->compose($args);
102 |         }
103 | 
104 |         if (! is_a($partial, FieldsBuilder::class)) {
105 |             throw new InvalidArgumentException('The partial must return an instance of Builder.');
106 |         }
107 | 
108 |         return $this->addFields($partial);
109 |     }
110 | 
111 |     /**
112 |      * Add multiple partials to the field group.
113 |      */
114 |     public function addPartials(array $partials): self
115 |     {
116 |         foreach ($partials as $key => $value) {
117 |             $partial = is_string($value) ? $value : $key;
118 |             $args = is_array($value) ? $value : [];
119 | 
120 |             $this->addPartial($partial, $args);
121 |         }
122 | 
123 |         return $this;
124 |     }
125 | 
126 |     /**
127 |      * Retrieve the custom field types.
128 |      */
129 |     protected function getFieldTypes(): array
130 |     {
131 |         if (! is_null($this->types)) {
132 |             return $this->types;
133 |         }
134 | 
135 |         $types = config('acf.types', []);
136 | 
137 |         return $this->types = $this->collect($types)->mapWithKeys(fn ($type, $key) => [
138 |             Str::of($key)->studly()->start('add')->toString() => $type,
139 |         ])->all();
140 |     }
141 | 
142 |     /**
143 |      * Retrieve the specified field type.
144 |      */
145 |     protected function getFieldType(string $type): ?string
146 |     {
147 |         return $this->getFieldTypes()[$type] ?? null;
148 |     }
149 | 
150 |     /**
151 |      * Retrieve an instance of ACF Composer.
152 |      */
153 |     protected function composer(): AcfComposer
154 |     {
155 |         if ($this->composer) {
156 |             return $this->composer;
157 |         }
158 | 
159 |         return $this->composer = app('AcfComposer');
160 |     }
161 | 
162 |     /**
163 |      * {@inheritdoc}
164 |      */
165 |     public function addField($name, $type, array $args = [])
166 |     {
167 |         return $this->initializeField(new FieldBuilder($name, $type, $args));
168 |     }
169 | 
170 |     /**
171 |      * Initialize the field and push it to the field manager.
172 |      *
173 |      * @param  FieldBuilder  $field
174 |      * @return FieldBuilder
175 |      */
176 |     protected function initializeField($field)
177 |     {
178 |         $field->setParentContext($this);
179 | 
180 |         $this->getFieldManager()->pushField($field);
181 | 
182 |         return $field;
183 |     }
184 | 
185 |     /**
186 |      * {@inheritdoc}
187 |      */
188 |     public function setLocation($param, $operator, $value)
189 |     {
190 |         $location = parent::setLocation($param, $operator, $value);
191 | 
192 |         $location->setParentContext($this);
193 | 
194 |         return $location;
195 |     }
196 | 
197 |     /**
198 |      * Add a group field.
199 |      *
200 |      * @param  string  $name
201 |      * @return \Log1x\AcfComposer\Builder\GroupBuilder
202 |      */
203 |     public function addGroup($name, array $args = [])
204 |     {
205 |         return $this->initializeField(new GroupBuilder($name, 'group', $args));
206 |     }
207 | 
208 |     /**
209 |      * Add a repeater field.
210 |      *
211 |      * @param  string  $name
212 |      * @return \Log1x\AcfComposer\Builder\RepeaterBuilder
213 |      */
214 |     public function addRepeater($name, array $args = [])
215 |     {
216 |         return $this->initializeField(new RepeaterBuilder($name, 'repeater', $args));
217 |     }
218 | 
219 |     /**
220 |      * Add a flexible content field.
221 |      *
222 |      * @param  string  $name
223 |      * @return \Log1x\AcfComposer\Builder\FlexibleContentBuilder
224 |      */
225 |     public function addFlexibleContent($name, array $args = [])
226 |     {
227 |         return $this->initializeField(new FlexibleContentBuilder($name, 'flexible_content', $args));
228 |     }
229 | 
230 |     /**
231 |      * Add a tab field.
232 |      *
233 |      * @param  string  $label
234 |      * @return \Log1x\AcfComposer\Builder\TabBuilder
235 |      */
236 |     public function addTab($label, array $args = [])
237 |     {
238 |         return $this->initializeField(new TabBuilder($label, 'tab', $args));
239 |     }
240 | 
241 |     /**
242 |      * Add an accordion field.
243 |      *
244 |      * @param  string  $label
245 |      * @return \Log1x\AcfComposer\Builder\AccordionBuilder
246 |      */
247 |     public function addAccordion($label, array $args = [])
248 |     {
249 |         return $this->initializeField(new AccordionBuilder($label, 'accordion', $args));
250 |     }
251 | 
252 |     /**
253 |      * Add a choice field.
254 |      *
255 |      * @param  string  $name
256 |      * @param  string  $type
257 |      * @return \Log1x\AcfComposer\Builder\ChoiceFieldBuilder
258 |      */
259 |     public function addChoiceField($name, $type, array $args = [])
260 |     {
261 |         return $this->initializeField(new ChoiceFieldBuilder($name, $type, $args));
262 |     }
263 | 
264 |     /**
265 |      * Check for custom field types before calling the requested method.
266 |      *
267 |      * @param  string  $method
268 |      * @param  array  $arguments
269 |      * @return mixed
270 |      */
271 |     public function __call($method, $arguments)
272 |     {
273 |         if ($context = $this->getParentContext()) {
274 |             if ($type = $context->getFieldType($method)) {
275 |                 $name = array_shift($arguments);
276 | 
277 |                 return $this->addField($name, $type, ...$arguments);
278 |             }
279 |         }
280 | 
281 |         if ($type = $this->getFieldType($method)) {
282 |             $name = array_shift($arguments);
283 | 
284 |             return $this->addField($name, $type, ...$arguments);
285 |         }
286 | 
287 |         return parent::__call($method, $arguments);
288 |     }
289 | }
290 | 


--------------------------------------------------------------------------------
/src/AcfComposer.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Log1x\AcfComposer;
  4 | 
  5 | use Illuminate\Support\Facades\File;
  6 | use Illuminate\Support\Str;
  7 | use Log1x\AcfComposer\Concerns\HasCollection;
  8 | use Log1x\AcfComposer\Exceptions\DuplicateKeyException;
  9 | use ReflectionClass;
 10 | use Roots\Acorn\Application;
 11 | use Symfony\Component\Finder\Finder;
 12 | 
 13 | class AcfComposer
 14 | {
 15 |     use HasCollection;
 16 | 
 17 |     /**
 18 |      * The booted state.
 19 |      */
 20 |     protected bool $booted = false;
 21 | 
 22 |     /**
 23 |      * The registered paths.
 24 |      */
 25 |     protected array $paths = [];
 26 | 
 27 |     /**
 28 |      * The registered composers.
 29 |      */
 30 |     protected array $composers = [];
 31 | 
 32 |     /**
 33 |      * The deferred composers.
 34 |      */
 35 |     protected array $deferredOptions = [];
 36 | 
 37 |     /**
 38 |      * The pending composers.
 39 |      */
 40 |     protected array $pendingComposers = [];
 41 | 
 42 |     /**
 43 |      * The legacy widgets.
 44 |      */
 45 |     protected array $legacyWidgets = [];
 46 | 
 47 |     /**
 48 |      * The registered plugin paths.
 49 |      */
 50 |     protected array $plugins = [];
 51 | 
 52 |     /**
 53 |      * The cache manifest.
 54 |      */
 55 |     protected Manifest $manifest;
 56 | 
 57 |     /**
 58 |      * The composer classes.
 59 |      */
 60 |     protected array $classes = [
 61 |         'Fields',
 62 |         'Blocks',
 63 |         'Widgets',
 64 |         'Options',
 65 |     ];
 66 | 
 67 |     /**
 68 |      * Create a new Composer instance.
 69 |      */
 70 |     public function __construct(public Application $app)
 71 |     {
 72 |         $this->manifest = Manifest::make($this);
 73 |     }
 74 | 
 75 |     /**
 76 |      * Make a new Composer instance.
 77 |      */
 78 |     public static function make(Application $app): self
 79 |     {
 80 |         return new static($app);
 81 |     }
 82 | 
 83 |     /**
 84 |      * Boot the registered Composers.
 85 |      */
 86 |     public function boot(): void
 87 |     {
 88 |         if ($this->booted()) {
 89 |             return;
 90 |         }
 91 | 
 92 |         $this->registerDefaultPath();
 93 | 
 94 |         $this->handleBlocks();
 95 |         $this->handleWidgets();
 96 | 
 97 |         add_filter('acf/init', fn () => $this->handleComposers(), config('acf.hookPriority', 100));
 98 | 
 99 |         add_filter('acf/input/admin_footer', function () {
100 |             echo view('acf-composer::alpine-support')->render();
101 |         });
102 | 
103 |         $this->booted = true;
104 |     }
105 | 
106 |     /**
107 |      * Handle the Composer registration.
108 |      */
109 |     public function handleComposers(): void
110 |     {
111 |         foreach ($this->composers as $namespace => $composers) {
112 |             foreach ($composers as $i => $composer) {
113 |                 if (! is_subclass_of($composer, Options::class)) {
114 |                     $this->pendingComposers[$namespace][] = $composer;
115 | 
116 |                     unset($this->composers[$namespace][$i]);
117 | 
118 |                     continue;
119 |                 }
120 | 
121 |                 $composer = $composer::make($this);
122 | 
123 |                 if (! is_null($composer->parent)) {
124 |                     $this->deferredOptions[$namespace][] = $composer;
125 | 
126 |                     unset($this->composers[$namespace][$i]);
127 | 
128 |                     continue;
129 |                 }
130 | 
131 |                 $this->composers[$namespace][$i] = $composer->handle();
132 |             }
133 |         }
134 | 
135 |         foreach ($this->deferredOptions as $namespace => $composers) {
136 |             foreach ($composers as $index => $composer) {
137 |                 $this->composers[$namespace][] = $composer->handle();
138 |             }
139 |         }
140 | 
141 |         foreach ($this->pendingComposers as $namespace => $composers) {
142 |             foreach ($composers as $composer) {
143 |                 $this->composers[$namespace][] = $composer::make($this)->handle();
144 |             }
145 |         }
146 | 
147 |         $this->deferredOptions = [];
148 |         $this->pendingComposers = [];
149 | 
150 |         foreach ($this->composers as $namespace => $composers) {
151 |             $names = [];
152 | 
153 |             foreach ($composers as $composer) {
154 |                 $group = $composer->getFields();
155 | 
156 |                 $key = $group['key'] ?? $group[0]['key'] ?? null;
157 | 
158 |                 if (! $key) {
159 |                     continue;
160 |                 }
161 | 
162 |                 if (isset($names[$key])) {
163 |                     $class = $composer::class;
164 | 
165 |                     throw new DuplicateKeyException("Duplicate ACF field group key [{$key}] found in [{$class}] and [{$names[$key]}].");
166 |                 }
167 | 
168 |                 $names[$key] = $composer::class;
169 |             }
170 | 
171 |             $this->composers[$namespace] = array_values($composers);
172 |         }
173 |     }
174 | 
175 |     /**
176 |      * Handle the Widget Composer registration.
177 |      */
178 |     public function handleWidgets(): void
179 |     {
180 |         foreach ($this->legacyWidgets as $namespace => $composers) {
181 |             foreach ($composers as $composer) {
182 |                 $composer = $composer::make($this);
183 | 
184 |                 $this->composers[$namespace][] = $composer->handle();
185 |             }
186 |         }
187 | 
188 |         $this->legacyWidgets = [];
189 |     }
190 | 
191 |     /**
192 |      * Handle the block rendering.
193 |      */
194 |     protected function handleBlocks(): void
195 |     {
196 |         if (is_admin()) {
197 |             add_action('enqueue_block_assets', function () {
198 |                 foreach ($this->composers() as $composers) {
199 |                     foreach ($composers as $composer) {
200 |                         if (! is_a($composer, Block::class)) {
201 |                             continue;
202 |                         }
203 | 
204 |                         method_exists($composer, 'assets') && $composer->assets((array) $composer->block ?? []);
205 |                     }
206 |                 }
207 |             });
208 |         }
209 | 
210 |         add_action('enqueue_block_editor_assets', function () {
211 |             wp_add_inline_script('wp-blocks', view('acf-composer::block-editor-filters')->render());
212 |         });
213 | 
214 |         add_action('acf_block_render_template', function ($block, $content, $is_preview, $post_id, $wp_block, $context) {
215 |             if (! class_exists($composer = $block['render_template'] ?? '')) {
216 |                 return;
217 |             }
218 | 
219 |             if (! $composer = app('AcfComposer')->getComposer($composer)) {
220 |                 return;
221 |             }
222 | 
223 |             add_filter('acf/blocks/template_not_found_message', fn () => '');
224 | 
225 |             echo $composer->render($block, $content, $is_preview, $post_id, $wp_block, $context);
226 |         }, 9, 6);
227 |     }
228 | 
229 |     /**
230 |      * Register the default application path.
231 |      */
232 |     public function registerDefaultPath(): void
233 |     {
234 |         $this->registerPath($this->app->path());
235 |     }
236 | 
237 |     /**
238 |      * Register the specified path with ACF Composer.
239 |      */
240 |     public function registerPath(string $path, ?string $namespace = null): array
241 |     {
242 |         $paths = $this->collect(File::directories($path))
243 |             ->filter(fn ($item) => Str::contains($item, $this->classes));
244 | 
245 |         if ($paths->isEmpty()) {
246 |             return [];
247 |         }
248 | 
249 |         if (empty($namespace)) {
250 |             $namespace = $this->app->getNamespace();
251 |         }
252 | 
253 |         foreach ((new Finder)->in($paths->toArray())->files()->sortByName() as $file) {
254 |             $relativePath = str_replace(
255 |                 Str::finish($path, DIRECTORY_SEPARATOR),
256 |                 '',
257 |                 $file->getPathname()
258 |             );
259 | 
260 |             $folders = Str::beforeLast(
261 |                 $relativePath,
262 |                 DIRECTORY_SEPARATOR
263 |             ).DIRECTORY_SEPARATOR;
264 | 
265 |             $className = Str::after($relativePath, $folders);
266 | 
267 |             $composer = $namespace.str_replace(
268 |                 ['/', '.php'],
269 |                 ['\\', ''],
270 |                 $folders.$className
271 |             );
272 | 
273 |             $this->paths[$path][] = $composer;
274 | 
275 |             $this->register($composer, $namespace);
276 |         }
277 | 
278 |         return $this->paths;
279 |     }
280 | 
281 |     /**
282 |      * Register a Composer with ACF Composer.
283 |      */
284 |     public function register(string $composer, string $namespace): bool
285 |     {
286 |         if (
287 |             ! is_subclass_of($composer, Composer::class) ||
288 |             is_subclass_of($composer, Partial::class) ||
289 |             (new ReflectionClass($composer))->isAbstract()
290 |         ) {
291 |             return false;
292 |         }
293 | 
294 |         if (is_subclass_of($composer, Widget::class)) {
295 |             $this->legacyWidgets[$namespace][] = $composer;
296 | 
297 |             return true;
298 |         }
299 | 
300 |         $this->composers[$namespace][] = $composer;
301 | 
302 |         return true;
303 |     }
304 | 
305 |     /**
306 |      * Register an ACF Composer plugin with the container.
307 |      */
308 |     public function registerPlugin(string $path, string $namespace): void
309 |     {
310 |         $namespace = str_replace('Providers', '', $namespace);
311 | 
312 |         $this->registerPath($path, $namespace);
313 | 
314 |         $this->plugins[$namespace] = $path;
315 |     }
316 | 
317 |     /**
318 |      * Retrieve the registered composers.
319 |      */
320 |     public function composers(): array
321 |     {
322 |         return $this->composers;
323 |     }
324 | 
325 |     /**
326 |      * Retrieve a Composer instance by class name.
327 |      */
328 |     public function getComposer(string $class): ?Composer
329 |     {
330 |         foreach ($this->composers as $composers) {
331 |             foreach ($composers as $composer) {
332 |                 if ($composer::class === $class) {
333 |                     return $composer;
334 |                 }
335 |             }
336 |         }
337 | 
338 |         return null;
339 |     }
340 | 
341 |     /**
342 |      * Retrieve the registered paths.
343 |      */
344 |     public function paths(): array
345 |     {
346 |         return array_unique($this->paths);
347 |     }
348 | 
349 |     /**
350 |      * Retrieve the registered plugins.
351 |      */
352 |     public function plugins(): array
353 |     {
354 |         return $this->plugins;
355 |     }
356 | 
357 |     /**
358 |      * Retrieve the cache manifest.
359 |      */
360 |     public function manifest(): Manifest
361 |     {
362 |         return $this->manifest;
363 |     }
364 | 
365 |     /**
366 |      * Determine if ACF Composer is booted.
367 |      */
368 |     public function booted(): bool
369 |     {
370 |         return $this->booted;
371 |     }
372 | }
373 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # ACF Composer
  2 | 
  3 | ![Latest Stable Version](https://img.shields.io/packagist/v/log1x/acf-composer.svg?style=flat-square)
  4 | ![Total Downloads](https://img.shields.io/packagist/dt/log1x/acf-composer.svg?style=flat-square)
  5 | ![Build Status](https://img.shields.io/github/actions/workflow/status/log1x/acf-composer/main.yml?branch=master&style=flat-square)
  6 | 
  7 | ACF Composer is the ultimate tool for creating fields, blocks, widgets, and option pages using [ACF Builder](https://github.com/stoutlogic/acf-builder) alongside [Sage 10](https://github.com/roots/sage).
  8 | 
  9 | ![Screenshot](https://i.imgur.com/7e7w3U9.png)
 10 | 
 11 | ## Features
 12 | 
 13 | - 🔧 Encourages clean structuring for creating fields with Sage 10 and ACF.
 14 | - 🚀 Instantly generate working fields, blocks, widgets, partials, and option pages using CLI. Batteries included.
 15 | - 🖼️ Fully rendered blocks and widgets using Blade with a native Sage 10 feel for passing view data.
 16 | - ⚡ Seamlessly [cache](#caching-blocks--fields) blocks to `block.json` and field groups to a manifest.
 17 | - 📦 Automatically hooks legacy widgets with `WP_Widget` making them instantly ready to use.
 18 | - 🛠️ Automatically sets field location on blocks, widgets, and option pages.
 19 | - 🌐 Globally define default field type and field group settings. No more repeating `['ui' => 1]` on every select field.
 20 | 
 21 | ## Requirements
 22 | 
 23 | - [Sage](https://github.com/roots/sage) >= 10.0
 24 | - [Acorn](https://github.com/roots/acorn) >= 3.0
 25 | - [ACF Pro](https://www.advancedcustomfields.com/) >= 5.8.0
 26 | 
 27 | ## Installation
 28 | 
 29 | Install via Composer:
 30 | 
 31 | ```bash
 32 | $ composer require log1x/acf-composer
 33 | ```
 34 | 
 35 | ## Usage
 36 | 
 37 | ### Getting Started
 38 | 
 39 | Start by publishing the `config/acf.php` configuration file using Acorn:
 40 | 
 41 | ```bash
 42 | $ wp acorn vendor:publish --tag="acf-composer"
 43 | ```
 44 | 
 45 | ### Generating a Field Group
 46 | 
 47 | To create your first field group, start by running the following generator command from your theme directory:
 48 | 
 49 | ```bash
 50 | $ wp acorn acf:field ExampleField
 51 | ```
 52 | 
 53 | This will create `src/Fields/ExampleField.php` which is where you will create and manage your first field group.
 54 | 
 55 | Taking a glance at the generated `ExampleField.php` stub, you will notice that it has a simple list configured.
 56 | 
 57 | ```php
 58 | <?php
 59 | 
 60 | namespace App\Fields;
 61 | 
 62 | use Log1x\AcfComposer\Builder;
 63 | use Log1x\AcfComposer\Field;
 64 | 
 65 | class ExampleField extends Field
 66 | {
 67 |     /**
 68 |      * The field group.
 69 |      *
 70 |      * @return array
 71 |      */
 72 |     public function fields()
 73 |     {
 74 |         $fields = Builder::make('example_field');
 75 | 
 76 |         $fields
 77 |             ->setLocation('post_type', '==', 'post');
 78 | 
 79 |         $fields
 80 |             ->addRepeater('items')
 81 |                 ->addText('item')
 82 |             ->endRepeater();
 83 | 
 84 |         return $fields->build();
 85 |     }
 86 | }
 87 | ```
 88 | 
 89 | Proceed by checking the `Add Post` for the field to ensure things are working as intended.
 90 | 
 91 | ### Field Builder Usage
 92 | 
 93 | To assist with development, ACF Composer comes with a `usage` command that will let you search for registered field types. This will provide basic information about the field type as well as a usage example containing all possible options.
 94 | 
 95 | ```sh
 96 | $ wp acorn acf:usage
 97 | ```
 98 | 
 99 | For additional usage, you may consult the [ACF Builder Cheatsheet](https://github.com/Log1x/acf-builder-cheatsheet).
100 | 
101 | ### Generating a Field Partial
102 | 
103 | A field partial consists of a field group that can be re-used and/or added to existing field groups.
104 | 
105 | To start, let's generate a partial called _ListItems_ that we can use in the _Example_ field we generated above.
106 | 
107 | ```bash
108 | $ wp acorn acf:partial ListItems
109 | ```
110 | 
111 | ```php
112 | <?php
113 | 
114 | namespace App\Fields\Partials;
115 | 
116 | use Log1x\AcfComposer\Builder;
117 | use Log1x\AcfComposer\Partial;
118 | 
119 | class ListItems extends Partial
120 | {
121 |     /**
122 |      * The partial field group.
123 |      *
124 |      * @return array
125 |      */
126 |     public function fields()
127 |     {
128 |         $fields = Builder::make('listItems');
129 | 
130 |         $fields
131 |             ->addRepeater('items')
132 |                 ->addText('item')
133 |             ->endRepeater();
134 | 
135 |         return $fields;
136 |     }
137 | }
138 | ```
139 | 
140 | Looking at `ListItems.php`, you will see out of the box it consists of an identical list repeater as seen in your generated field.
141 | 
142 | A key difference to note compared to an ordinary field is the omitting of `->build()` instead returning the `FieldsBuilder` instance itself.
143 | 
144 | This can be utilized in our _Example_ field by passing the `::class` constant to `->addPartial()`:
145 | 
146 | ```php
147 | <?php
148 | 
149 | namespace App\Fields;
150 | 
151 | use App\Fields\Partials\ListItems;
152 | use Log1x\AcfComposer\Builder;
153 | use Log1x\AcfComposer\Field;
154 | 
155 | class Example extends Field
156 | {
157 |     /**
158 |      * The field group.
159 |      *
160 |      * @return array
161 |      */
162 |     public function fields()
163 |     {
164 |         $fields = Builder::make('example');
165 | 
166 |         $fields
167 |             ->setLocation('post_type', '==', 'post');
168 | 
169 |         $fields
170 |             ->addPartial(ListItems::class);
171 | 
172 |         return $fields->build();
173 |     }
174 | }
175 | ```
176 | 
177 | ### Generating a Block
178 | 
179 | Generating a block is generally the same as generating a field as seen above.
180 | 
181 | Start by creating the block field using Acorn:
182 | 
183 | ```bash
184 | $ wp acorn acf:block ExampleBlock
185 | ```
186 | 
187 | ```php
188 | <?php
189 | 
190 | namespace App\Blocks;
191 | 
192 | use Log1x\AcfComposer\Block;
193 | use Log1x\AcfComposer\Builder;
194 | 
195 | class ExampleBlock extends Block
196 | {
197 |     /**
198 |      * The block name.
199 |      *
200 |      * @var string
201 |      */
202 |     public $name = 'Example Block';
203 | 
204 |     /**
205 |      * The block description.
206 |      *
207 |      * @var string
208 |      */
209 |     public $description = 'Lorem ipsum...';
210 | 
211 |     /**
212 |      * The block category.
213 |      *
214 |      * @var string
215 |      */
216 |     public $category = 'common';
217 | 
218 |     /**
219 |      * The block icon.
220 |      *
221 |      * @var string|array
222 |      */
223 |     public $icon = 'star-half';
224 | 
225 |     /**
226 |      * Data to be passed to the block before rendering.
227 |      *
228 |      * @return array
229 |      */
230 |     public function with()
231 |     {
232 |         return [
233 |             'items' => $this->items(),
234 |         ];
235 |     }
236 | 
237 |     /**
238 |      * The block field group.
239 |      *
240 |      * @return array
241 |      */
242 |     public function fields()
243 |     {
244 |         $fields = Builder::make('example_block');
245 | 
246 |         $fields
247 |             ->addRepeater('items')
248 |                 ->addText('item')
249 |             ->endRepeater();
250 | 
251 |         return $fields->build();
252 |     }
253 | 
254 |     /**
255 |      * Return the items field.
256 |      *
257 |      * @return array
258 |      */
259 |     public function items()
260 |     {
261 |         return get_field('items') ?: [];
262 |     }
263 | }
264 | ```
265 | 
266 | You may also pass `--localize` to the command above to generate a block stub with the name and description ready for translation.
267 | 
268 | ```bash
269 | $ wp acorn acf:block Example --localize
270 | ```
271 | 
272 | When running the block generator, one difference to a generic field is an accompanied `View` is generated in the `resources/views/blocks` directory.
273 | 
274 | ```php
275 | @if ($items)
276 |   <ul>
277 |     @foreach ($items as $item)
278 |       <li>{{ $item['item'] }}</li>
279 |     @endforeach
280 |   </ul>
281 | @else
282 |   <p>No items found!</p>
283 | @endif
284 | 
285 | <div>
286 |   <InnerBlocks />
287 | </div>
288 | ```
289 | 
290 | Like the field generator, the example block contains a simple list repeater and is working out of the box.
291 | 
292 | #### Block Preview View
293 | 
294 | While `$block->preview` is an option for conditionally modifying your block when shown in the editor, you may also render your block using a seperate view.
295 | 
296 | Simply duplicate your existing view prefixing it with `preview-` (e.g. `preview-example.blade.php`).
297 | 
298 | ### Generating a Widget
299 | 
300 | > [!IMPORTANT]
301 | > With WordPress 5.8, Blocks can now be used as widgets making this feature somewhat deprecated as you would just make a block instead.
302 | >
303 | > If you are on the latest WordPress and would like to use the classic widget functionality from ACF Composer, you will need to [opt-out of the widget block editor](https://developer.wordpress.org/block-editor/how-to-guides/widgets/opting-out/).
304 | 
305 | Creating a sidebar widget using ACF Composer is extremely easy. Widgets are automatically loaded and rendered with Blade, as well as registered with `WP_Widget` which is usually rather annoying.
306 | 
307 | Start by creating a widget using Acorn:
308 | 
309 | ```bash
310 | $ wp acorn acf:widget ExampleWidget
311 | ```
312 | 
313 | ```php
314 | <?php
315 | 
316 | namespace App\Widgets;
317 | 
318 | use Log1x\AcfComposer\Builder;
319 | use Log1x\AcfComposer\Widget;
320 | 
321 | class ExampleWidget extends Widget
322 | {
323 |     /**
324 |      * The widget name.
325 |      *
326 |      * @var string
327 |      */
328 |     public $name = 'Example Widget';
329 | 
330 |     /**
331 |      * The widget description.
332 |      *
333 |      * @var string
334 |      */
335 |     public $description = 'Lorem ipsum...';
336 | 
337 |     /**
338 |      * Data to be passed to the widget before rendering.
339 |      *
340 |      * @return array
341 |      */
342 |     public function with()
343 |     {
344 |         return [
345 |             'items' => $this->items(),
346 |         ];
347 |     }
348 | 
349 |     /**
350 |      * The widget title.
351 |      *
352 |      * @return string
353 |      */
354 |     public function title() {
355 |         return get_field('title', $this->widget->id);
356 |     }
357 | 
358 |     /**
359 |      * The widget field group.
360 |      *
361 |      * @return array
362 |      */
363 |     public function fields()
364 |     {
365 |         $fields = Builder::make('example_widget');
366 | 
367 |         $fields
368 |             ->addText('title');
369 | 
370 |         $fields
371 |             ->addRepeater('items')
372 |                 ->addText('item')
373 |             ->endRepeater();
374 | 
375 |         return $fields->build();
376 |     }
377 | 
378 |     /**
379 |      * Return the items field.
380 |      *
381 |      * @return array
382 |      */
383 |     public function items()
384 |     {
385 |         return get_field('items', $this->widget->id) ?: [];
386 |     }
387 | }
388 | ```
389 | 
390 | Similar to blocks, widgets are also accompanied by a view generated in `resources/views/widgets`.
391 | 
392 | ```php
393 | @if ($items)
394 |   <ul>
395 |     @foreach ($items as $item)
396 |       <li>{{ $item['item'] }}</li>
397 |     @endforeach
398 |   </ul>
399 | @else
400 |   <p>No items found!</p>
401 | @endif
402 | ```
403 | 
404 | Out of the box, the Example widget is ready to go and should appear in the backend.
405 | 
406 | ### Generating an Options Page
407 | 
408 | Creating an options page is similar to creating a regular field group in additional to a few configuration options available to customize the page (most of which, are optional.)
409 | 
410 | Start by creating an option page using Acorn:
411 | 
412 | ```bash
413 | $ wp acorn acf:options ExampleOptions
414 | ```
415 | 
416 | ```php
417 | <?php
418 | 
419 | namespace App\Options;
420 | 
421 | use Log1x\AcfComposer\Builder;
422 | use Log1x\AcfComposer\Options as Field;
423 | 
424 | class ExampleOptions extends Field
425 | {
426 |     /**
427 |      * The option page menu name.
428 |      *
429 |      * @var string
430 |      */
431 |     public $name = 'Example Options';
432 | 
433 |     /**
434 |      * The option page document title.
435 |      *
436 |      * @var string
437 |      */
438 |     public $title = 'Example Options | Options';
439 | 
440 |     /**
441 |      * The option page field group.
442 |      *
443 |      * @return array
444 |      */
445 |     public function fields()
446 |     {
447 |         $fields = Builder::make('example_options');
448 | 
449 |         $fields
450 |             ->addRepeater('items')
451 |                 ->addText('item')
452 |             ->endRepeater();
453 | 
454 |         return $fields->build();
455 |     }
456 | }
457 | ```
458 | 
459 | Optionally, you may pass `--full` to the command above to generate a stub that contains additional configuration examples.
460 | 
461 | ```bash
462 | $ wp acorn acf:options Options --full
463 | ```
464 | 
465 | Once finished, you should see an Options page appear in the backend.
466 | 
467 | All fields registered will have their location automatically set to this page.
468 | 
469 | ## Caching Blocks & Fields
470 | 
471 | As of v3, ACF Composer now has the ability to cache registered blocks to native `block.json` files and field groups to a flat file JSON manifest automatically using CLI.
472 | 
473 | This can lead to a **dramatic increase** in performance in projects both small and large, especially when loading a post in the editor containing multiple custom blocks.
474 | 
475 | > [!NOTE]
476 | > Making changes to blocks or fields once cached will not take effect until cleared or re-cached.
477 | 
478 | The best time to do this is during deployment and can be done using the `acf:cache` command:
479 | 
480 | ```bash
481 | $ wp acorn acf:cache [--status]
482 | ```
483 | 
484 | Cache can then be cleared using the `acf:clear` command:
485 | 
486 | ```bash
487 | $ wp acorn acf:clear
488 | ```
489 | 
490 | The ACF Composer cache status can be found using `--status` on `acf:cache` as seen above or by running `wp acorn about`.
491 | 
492 | ## Custom Stub Generation
493 | 
494 | To customize the stubs generated by ACF Composer, you can easily publish the `stubs` directory using Acorn:
495 | 
496 | ```bash
497 | $ wp acorn acf:stubs
498 | ```
499 | 
500 | The publish command generates all available stubs by default. However, each stub file is optional. When a stub file doesn't exist in the `stubs/acf-composer` directory, the default stub provided by the package will be used.
501 | 
502 | ## Default Field Settings
503 | 
504 | A useful feature unique to ACF Composer is the ability to set field type as well as field group defaults. Any globally set default can of course be over-ridden by simply setting it on the individual field.
505 | 
506 | ### Global
507 | 
508 | Taking a look at `config/acf.php`, you will see a few pre-configured defaults:
509 | 
510 | ```php
511 | 'defaults' => [
512 |     'trueFalse' => ['ui' => 1],
513 |     'select' => ['ui' => 1],
514 | ],
515 | ```
516 | 
517 | When setting `trueFalse` and `select` to have their `ui` set to `1` by default, it is no longer necessary to repeatedly set `'ui' => 1` on your fields. This takes effect globally and can be overridden by simply setting a different value on a field.
518 | 
519 | ### Field Group
520 | 
521 | It is also possible to define defaults on individual field groups. This is done by simply defining `$defaults` in your field class.
522 | 
523 | ```php
524 | /**
525 |  * Default field type settings.
526 |  *
527 |  * @return array
528 |  */
529 | protected $defaults = ['ui' => 0];
530 | ```
531 | 
532 | ### My Defaults
533 | 
534 | Here are a couple defaults I personally use. Any prefixed with `acfe_` are related to [ACF Extended](https://www.acf-extended.com/).
535 | 
536 | ```php
537 | 'defaults' => [
538 |     'fieldGroup' => ['instruction_placement' => 'acfe_instructions_tooltip'],
539 |     'repeater' => ['layout' => 'block', 'acfe_repeater_stylised_button' => 1],
540 |     'trueFalse' => ['ui' => 1],
541 |     'select' => ['ui' => 1],
542 |     'postObject' => ['ui' => 1, 'return_format' => 'object'],
543 |     'accordion' => ['multi_expand' => 1],
544 |     'group' => ['layout' => 'table', 'acfe_group_modal' => 1],
545 |     'tab' => ['placement' => 'left'],
546 |     'sidebar_selector' => ['default_value' => 'sidebar-primary', 'allow_null' => 1]
547 | ],
548 | ```
549 | 
550 | ## Bug Reports
551 | 
552 | If you discover a bug in ACF Composer, please [open an issue](https://github.com/log1x/acf-composer/issues).
553 | 
554 | ## Contributing
555 | 
556 | Contributing whether it be through PRs, reporting an issue, or suggesting an idea is encouraged and appreciated.
557 | 
558 | ## License
559 | 
560 | ACF Composer is provided under the [MIT License](LICENSE.md).
561 | 


--------------------------------------------------------------------------------
/src/Block.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Log1x\AcfComposer;
  4 | 
  5 | use Exception;
  6 | use Illuminate\Support\Arr;
  7 | use Illuminate\Support\Collection;
  8 | use Illuminate\Support\Str;
  9 | use Illuminate\View\ComponentAttributeBag;
 10 | use Log1x\AcfComposer\Concerns\InteractsWithBlade;
 11 | use Log1x\AcfComposer\Contracts\Block as BlockContract;
 12 | use WP_Block_Supports;
 13 | 
 14 | use function Roots\asset;
 15 | 
 16 | abstract class Block extends Composer implements BlockContract
 17 | {
 18 |     use InteractsWithBlade;
 19 | 
 20 |     /**
 21 |      * The block properties.
 22 |      *
 23 |      * @var array|object
 24 |      */
 25 |     public $block;
 26 | 
 27 |     /**
 28 |      * The block content.
 29 |      *
 30 |      * @var string
 31 |      */
 32 |     public $content;
 33 | 
 34 |     /**
 35 |      * The block preview status.
 36 |      *
 37 |      * @var bool
 38 |      */
 39 |     public $preview;
 40 | 
 41 |     /**
 42 |      * The current post ID.
 43 |      *
 44 |      * @var int
 45 |      */
 46 |     public $post_id;
 47 | 
 48 |     /**
 49 |      * The block instance.
 50 |      *
 51 |      * @var \WP_Block
 52 |      */
 53 |     public $instance;
 54 | 
 55 |     /**
 56 |      * The block context.
 57 |      *
 58 |      * @var array
 59 |      */
 60 |     public $context;
 61 | 
 62 |     /**
 63 |      * The current post.
 64 |      *
 65 |      * @var \WP_Post
 66 |      */
 67 |     public $post;
 68 | 
 69 |     /**
 70 |      * The block classes.
 71 |      *
 72 |      * @var string
 73 |      */
 74 |     public $classes;
 75 | 
 76 |     /**
 77 |      * The block prefix.
 78 |      *
 79 |      * @var string
 80 |      */
 81 |     public $prefix = 'acf/';
 82 | 
 83 |     /**
 84 |      * The block text domain.
 85 |      *
 86 |      * @var string
 87 |      */
 88 |     public $textDomain;
 89 | 
 90 |     /**
 91 |      * The block namespace.
 92 |      *
 93 |      * @var string
 94 |      */
 95 |     public $namespace;
 96 | 
 97 |     /**
 98 |      * The block name.
 99 |      *
100 |      * @var string
101 |      */
102 |     public $name = '';
103 | 
104 |     /**
105 |      * The block slug.
106 |      *
107 |      * @var string
108 |      */
109 |     public $slug = '';
110 | 
111 |     /**
112 |      * The block view.
113 |      *
114 |      * @var string
115 |      */
116 |     public $view;
117 | 
118 |     /**
119 |      * The block settings.
120 |      */
121 |     public ?Collection $settings = null;
122 | 
123 |     /**
124 |      * The block description.
125 |      *
126 |      * @var string
127 |      */
128 |     public $description = '';
129 | 
130 |     /**
131 |      * The block category.
132 |      *
133 |      * @var string
134 |      */
135 |     public $category = '';
136 | 
137 |     /**
138 |      * The block icon.
139 |      *
140 |      * @var string|array
141 |      */
142 |     public $icon = '';
143 | 
144 |     /**
145 |      * The block keywords.
146 |      *
147 |      * @var array
148 |      */
149 |     public $keywords = [];
150 | 
151 |     /**
152 |      * The parent block type allow list.
153 |      *
154 |      * @var array
155 |      */
156 |     public $parent = [];
157 | 
158 |     /**
159 |      * The ancestor block type allow list.
160 |      *
161 |      * @var array
162 |      */
163 |     public $ancestor = [];
164 | 
165 |     /**
166 |      * The block post type allow list.
167 |      *
168 |      * @var array
169 |      */
170 |     public $post_types = [];
171 | 
172 |     /**
173 |      * The default block mode.
174 |      *
175 |      * @var string
176 |      */
177 |     public $mode = 'preview';
178 | 
179 |     /**
180 |      * The default block alignment.
181 |      *
182 |      * @var string
183 |      */
184 |     public $align = '';
185 | 
186 |     /**
187 |      * The default block text alignment.
188 |      *
189 |      * @var string
190 |      */
191 |     public $align_text = '';
192 | 
193 |     /**
194 |      * The default block content alignment.
195 |      *
196 |      * @var string
197 |      */
198 |     public $align_content = '';
199 | 
200 |     /**
201 |      * The default block spacing.
202 |      *
203 |      * @var array
204 |      */
205 |     public $spacing = [
206 |         'padding' => null,
207 |         'margin' => null,
208 |     ];
209 | 
210 |     /**
211 |      * The supported block features.
212 |      *
213 |      * @var array
214 |      */
215 |     public $supports = [];
216 | 
217 |     /**
218 |      * The block styles.
219 |      *
220 |      * @var array
221 |      */
222 |     public $styles = [];
223 | 
224 |     /**
225 |      * The current block style.
226 |      *
227 |      * @var string
228 |      */
229 |     public $style;
230 | 
231 |     /**
232 |      * The block dimensions.
233 |      *
234 |      * @var string
235 |      */
236 |     public $inlineStyle;
237 | 
238 |     /**
239 |      * Context values inherited by the block.
240 |      *
241 |      * @var string[]
242 |      */
243 |     public $uses_context = [];
244 | 
245 |     /**
246 |      * Context provided by the block.
247 |      *
248 |      * @var string[]
249 |      */
250 |     public $provides_context = [];
251 | 
252 |     /**
253 |      * The block preview example data.
254 |      *
255 |      * @var array
256 |      */
257 |     public $example = [];
258 | 
259 |     /**
260 |      * The block template.
261 |      *
262 |      * @var array|string
263 |      */
264 |     public $template = [];
265 | 
266 |     /**
267 |      * Determine whether to save the block's data as post meta.
268 |      *
269 |      * @var bool
270 |      */
271 |     public $usePostMeta = false;
272 | 
273 |     /**
274 |      * The block API version.
275 |      *
276 |      * @var int|null
277 |      */
278 |     public $apiVersion = null;
279 | 
280 |     /**
281 |      * The internal ACF block version.
282 |      *
283 |      * @var int
284 |      */
285 |     public $blockVersion = 2;
286 | 
287 |     /**
288 |      * Validate block fields as per the field group configuration.
289 |      *
290 |      * @var bool
291 |      */
292 |     public $validate = true;
293 | 
294 |     /**
295 |      * The block attributes.
296 |      */
297 |     public function attributes(): array
298 |     {
299 |         return [];
300 |     }
301 | 
302 |     /**
303 |      * Set the attributes to the block properties.
304 |      */
305 |     public function mergeAttributes(): void
306 |     {
307 |         foreach ($this->attributes() as $key => $value) {
308 |             if (! property_exists($this, $key)) {
309 |                 continue;
310 |             }
311 | 
312 |             $this->{$key} = $value;
313 |         }
314 | 
315 |         $defaults = config('acf.blocks', []);
316 | 
317 |         foreach ($defaults as $key => $value) {
318 |             if (! property_exists($this, $key) || filled($this->{$key})) {
319 |                 continue;
320 |             }
321 | 
322 |             $this->{$key} = $value;
323 |         }
324 |     }
325 | 
326 |     /**
327 |      * Retrieve the block name.
328 |      */
329 |     public function getName(): string
330 |     {
331 |         return $this->name;
332 |     }
333 | 
334 |     /**
335 |      * Retrieve the block description.
336 |      */
337 |     public function getDescription(): string
338 |     {
339 |         return $this->description;
340 |     }
341 | 
342 |     /**
343 |      * Retrieve the active block style.
344 |      */
345 |     public function getStyle(): ?string
346 |     {
347 |         return Str::of($this->block->className ?? null)
348 |             ->matchAll('/is-style-(\S+)/')
349 |             ->get(0) ??
350 |             Arr::get($this->getDefaultStyle(), 'name');
351 |     }
352 | 
353 |     /**
354 |      * Retrieve the default style.
355 |      */
356 |     public function getDefaultStyle(): array
357 |     {
358 |         return $this->collect($this->getStyles())->firstWhere('isDefault') ?? [];
359 |     }
360 | 
361 |     /**
362 |      * Retrieve the block styles.
363 |      */
364 |     public function getStyles(): array
365 |     {
366 |         $styles = $this->collect($this->styles)->map(function ($value, $key) {
367 |             if (is_array($value)) {
368 |                 return $value;
369 |             }
370 | 
371 |             $name = is_bool($value) ? $key : $value;
372 |             $default = is_bool($value) ? $value : false;
373 | 
374 |             return [
375 |                 'name' => $name,
376 |                 'label' => Str::headline($name),
377 |                 'isDefault' => $default,
378 |             ];
379 |         });
380 | 
381 |         if (! $styles->where('isDefault', true)->count()) {
382 |             $styles = $styles->map(fn ($style, $key) => $key === 0
383 |                 ? Arr::set($style, 'isDefault', true)
384 |                 : $style
385 |             );
386 |         }
387 | 
388 |         return $styles->all();
389 |     }
390 | 
391 |     /**
392 |      * Retrieve the block supports.
393 |      */
394 |     public function getSupports(): array
395 |     {
396 |         $supports = $this->collect($this->supports)
397 |             ->mapWithKeys(fn ($value, $key) => [Str::camel($key) => $value])
398 |             ->merge($this->supports);
399 | 
400 |         $typography = $supports->get('typography', []);
401 | 
402 |         if ($supports->has('alignText')) {
403 |             $typography['textAlign'] = $supports->get('alignText');
404 | 
405 |             $supports->forget(['alignText', 'align_text']);
406 |         }
407 | 
408 |         if ($typography) {
409 |             $supports->put('typography', $typography);
410 |         }
411 | 
412 |         return $supports->all();
413 |     }
414 | 
415 |     /**
416 |      * Retrieve the block support attributes.
417 |      */
418 |     public function getSupportAttributes(): array
419 |     {
420 |         $attributes = [];
421 | 
422 |         if ($this->align) {
423 |             $attributes['align'] = [
424 |                 'type' => 'string',
425 |                 'default' => $this->align,
426 |             ];
427 |         }
428 | 
429 |         if ($this->align_content) {
430 |             $attributes['alignContent'] = [
431 |                 'type' => 'string',
432 |                 'default' => $this->align_content,
433 |             ];
434 |         }
435 | 
436 |         $styles = [];
437 | 
438 |         if ($this->align_text) {
439 |             $styles['typography']['textAlign'] = $this->align_text;
440 |         }
441 | 
442 |         $spacing = array_filter($this->spacing);
443 | 
444 |         if ($spacing) {
445 |             $styles['spacing'] = $spacing;
446 |         }
447 | 
448 |         if ($styles) {
449 |             $attributes['style'] = [
450 |                 'type' => 'object',
451 |                 'default' => $styles,
452 |             ];
453 |         }
454 | 
455 |         return $attributes;
456 |     }
457 | 
458 |     /**
459 |      * Retrieve the block HTML attributes.
460 |      */
461 |     public function getHtmlAttributes(): array
462 |     {
463 |         if ($this->preview) {
464 |             return [];
465 |         }
466 | 
467 |         return WP_Block_Supports::get_instance()?->apply_block_supports() ?? [];
468 |     }
469 | 
470 |     /**
471 |      * Retrieve the inline block styles.
472 |      */
473 |     public function getInlineStyle(): string
474 |     {
475 |         $supports = $this->getHtmlAttributes();
476 | 
477 |         return $supports['style'] ?? '';
478 |     }
479 | 
480 |     /**
481 |      * Retrieve the block classes.
482 |      */
483 |     public function getClasses(): string
484 |     {
485 |         $supports = $this->getHtmlAttributes();
486 | 
487 |         $class = $supports['class'] ?? '';
488 | 
489 |         if ($alignContent = $this->block->alignContent ?? $this->block->align_content ?? null) {
490 |             $class = "{$class} is-position-{$alignContent}";
491 |         }
492 | 
493 |         if ($this->block->fullHeight ?? $this->block->full_height ?? null) {
494 |             $class = "{$class} full-height";
495 |         }
496 | 
497 |         return str_replace(
498 |             acf_slugify($this->namespace),
499 |             $this->slug,
500 |             trim($class)
501 |         );
502 |     }
503 | 
504 |     /**
505 |      * Retrieve the component attribute bag.
506 |      */
507 |     protected function getComponentAttributeBag(): ComponentAttributeBag
508 |     {
509 |         return (new ComponentAttributeBag)
510 |             ->class($this->getClasses())
511 |             ->style($this->getInlineStyle())
512 |             ->merge(['id' => $this->block->anchor ?? null])
513 |             ->filter(fn ($value) => filled($value) && $value !== ';');
514 |     }
515 | 
516 |     /**
517 |      * Retrieve the block API version.
518 |      */
519 |     public function getApiVersion(): int
520 |     {
521 |         return $this->apiVersion ?? 2;
522 |     }
523 | 
524 |     /**
525 |      * Retrieve the block text domain.
526 |      */
527 |     public function getTextDomain(): string
528 |     {
529 |         return $this->textDomain
530 |             ?? wp_get_theme()?->get('TextDomain')
531 |             ?? 'acf-composer';
532 |     }
533 | 
534 |     /**
535 |      * Retrieve the block icon.
536 |      */
537 |     public function getIcon(): string|array
538 |     {
539 |         if (is_array($this->icon)) {
540 |             return $this->icon;
541 |         }
542 | 
543 |         if (Str::startsWith($this->icon, 'asset:')) {
544 |             $asset = Str::of($this->icon)
545 |                 ->after('asset:')
546 |                 ->before('.svg')
547 |                 ->replace('.', '/')
548 |                 ->finish('.svg');
549 | 
550 |             return asset($asset)->contents();
551 |         }
552 | 
553 |         return $this->icon;
554 |     }
555 | 
556 |     /**
557 |      * Handle the block template.
558 |      */
559 |     public function handleTemplate(array $template = []): Collection
560 |     {
561 |         return $this->collect($template)->map(function ($block, $key) {
562 |             $name = is_numeric($key)
563 |                 ? array_key_first((array) $block)
564 |                 : $key;
565 | 
566 |             $value = is_numeric($key)
567 |                 ? ($block[$name] ?? [])
568 |                 : $block;
569 | 
570 |             if (is_array($value) && isset($value['innerBlocks'])) {
571 |                 $innerBlocks = $this->handleTemplate($value['innerBlocks'])->all();
572 | 
573 |                 unset($value['innerBlocks']);
574 | 
575 |                 return [$name, $value, $innerBlocks];
576 |             }
577 | 
578 |             return [$name, $value];
579 |         })->values();
580 |     }
581 | 
582 |     /**
583 |      * Compose the fields and register the block.
584 |      */
585 |     public function compose(): ?self
586 |     {
587 |         $this->mergeAttributes();
588 | 
589 |         if (blank($this->getName())) {
590 |             return null;
591 |         }
592 | 
593 |         $this->slug = $this->slug ?: Str::slug(Str::kebab($this->getName()));
594 |         $this->view = $this->view ?: Str::start($this->slug, 'blocks.');
595 |         $this->namespace = $this->namespace ?? Str::start($this->slug, $this->prefix);
596 | 
597 |         if (! Arr::has($this->fields, 'location.0.0')) {
598 |             Arr::set($this->fields, 'location.0.0', [
599 |                 'param' => 'block',
600 |                 'operator' => '==',
601 |                 'value' => $this->namespace,
602 |             ]);
603 |         }
604 | 
605 |         $this->register(fn () => $this->hasJson()
606 |             ? register_block_type($this->jsonPath())
607 |             : $this->registerBlockType()
608 |         );
609 | 
610 |         return $this;
611 |     }
612 | 
613 |     /**
614 |      * Register the block type.
615 |      */
616 |     public function registerBlockType(): void
617 |     {
618 |         $block = acf_validate_block_type($this->settings()->all());
619 |         $block = apply_filters('acf/register_block_type_args', $block);
620 | 
621 |         if (acf_has_block_type($block['name'])) {
622 |             throw new Exception("Block type [{$block['name']}] is already registered.");
623 |         }
624 | 
625 |         $block['attributes'] = array_merge(
626 |             acf_get_block_type_default_attributes($block),
627 |             $block['attributes'] ?? []
628 |         );
629 | 
630 |         acf_get_store('block-types')->set($block['name'], $block);
631 | 
632 |         $block['render_callback'] = 'acf_render_block_callback';
633 | 
634 |         register_block_type(
635 |             $block['name'],
636 |             $block
637 |         );
638 | 
639 |         add_action('enqueue_block_editor_assets', 'acf_enqueue_block_assets');
640 |     }
641 | 
642 |     /**
643 |      * Retrieve the block settings.
644 |      */
645 |     public function settings(): Collection
646 |     {
647 |         if ($this->settings) {
648 |             return $this->settings;
649 |         }
650 | 
651 |         $settings = Collection::make([
652 |             'name' => $this->slug,
653 |             'title' => $this->getName(),
654 |             'description' => $this->getDescription(),
655 |             'category' => $this->category,
656 |             'icon' => $this->getIcon(),
657 |             'keywords' => $this->keywords,
658 |             'post_types' => $this->post_types,
659 |             'mode' => $this->mode,
660 |             'align' => $this->align,
661 |             'attributes' => $this->getSupportAttributes(),
662 |             'alignText' => $this->align_text ?? $this->align,
663 |             'alignContent' => $this->align_content,
664 |             'styles' => $this->getStyles(),
665 |             'supports' => $this->getSupports(),
666 |             'textdomain' => $this->getTextDomain(),
667 |             'acf_block_version' => $this->blockVersion,
668 |             'api_version' => $this->getApiVersion(),
669 |             'validate' => $this->validate,
670 |             'use_post_meta' => $this->usePostMeta,
671 |             'render_callback' => function (
672 |                 $block,
673 |                 $content = '',
674 |                 $preview = false,
675 |                 $post_id = 0,
676 |                 $wp_block = false,
677 |                 $context = false
678 |             ) {
679 |                 echo $this->render($block, $content, $preview, $post_id, $wp_block, $context);
680 |             },
681 |         ]);
682 | 
683 |         if (filled($this->parent)) {
684 |             $settings = $settings->put('parent', $this->parent);
685 |         }
686 | 
687 |         if (filled($this->ancestor)) {
688 |             $settings = $settings->put('ancestor', $this->ancestor);
689 |         }
690 | 
691 |         if ($this->example !== false) {
692 |             if (method_exists($this, 'example') && is_array($example = $this->example())) {
693 |                 $this->example = array_merge($this->example, $example);
694 |             }
695 | 
696 |             $settings = $settings->put('example', [
697 |                 'attributes' => [
698 |                     'mode' => 'preview',
699 |                     'data' => $this->example,
700 |                 ],
701 |             ]);
702 |         }
703 | 
704 |         if (! empty($this->uses_context)) {
705 |             $settings = $settings->put('uses_context', $this->uses_context);
706 |         }
707 | 
708 |         if (! empty($this->provides_context)) {
709 |             $settings = $settings->put('provides_context', $this->provides_context);
710 |         }
711 | 
712 |         return $this->settings = $settings;
713 |     }
714 | 
715 |     /**
716 |      * Retrieve the Block settings as JSON.
717 |      */
718 |     public function toJson(): string
719 |     {
720 |         $settings = $this->settings()
721 |             ->put('name', $this->namespace)
722 |             ->put('apiVersion', $this->getApiVersion())
723 |             ->put('acf', [
724 |                 'blockVersion' => $this->blockVersion,
725 |                 'mode' => $this->mode,
726 |                 'postTypes' => $this->post_types,
727 |                 'renderTemplate' => $this::class,
728 |                 'usePostMeta' => $this->usePostMeta,
729 |                 'validate' => $this->validate,
730 |             ])
731 |             ->forget([
732 |                 'api_version',
733 |                 'acf_block_version',
734 |                 'align',
735 |                 'alignContent',
736 |                 'alignText',
737 |                 'mode',
738 |                 'post_types',
739 |                 'render_callback',
740 |                 'use_post_meta',
741 |                 'validate',
742 |             ]);
743 | 
744 |         return $settings->filter()->toJson(JSON_PRETTY_PRINT);
745 |     }
746 | 
747 |     /**
748 |      * Retrieve the Block JSON path.
749 |      */
750 |     public function jsonPath(): string
751 |     {
752 |         return $this->composer->manifest()->path("blocks/{$this->slug}/block.json");
753 |     }
754 | 
755 |     /**
756 |      * Determine if the Block has a JSON file.
757 |      */
758 |     public function hasJson(): bool
759 |     {
760 |         return file_exists($this->jsonPath());
761 |     }
762 | 
763 |     /**
764 |      * Render the ACF block.
765 |      *
766 |      * @param  array  $block
767 |      * @param  string  $content
768 |      * @param  bool  $preview
769 |      * @param  int  $post_id
770 |      * @param  \WP_Block  $wp_block
771 |      * @param  array  $context
772 |      * @return string
773 |      */
774 |     public function render($block, $content = '', $preview = false, $post_id = 0, $wp_block = false, $context = false)
775 |     {
776 |         $this->block = (object) $block;
777 |         $this->content = $content;
778 |         $this->preview = $preview;
779 |         $this->post_id = $post_id;
780 |         $this->instance = $wp_block;
781 |         $this->context = $context;
782 | 
783 |         $this->post = get_post($post_id);
784 | 
785 |         $this->template = is_array($this->template)
786 |             ? $this->handleTemplate($this->template)->toJson()
787 |             : $this->template;
788 | 
789 |         $this->classes = $this->getClasses();
790 |         $this->style = $this->getStyle();
791 |         $this->inlineStyle = $this->getInlineStyle();
792 | 
793 |         if (! is_admin() && method_exists($this, 'assets')) {
794 |             $instance = (array) ($this->block ?? []);
795 | 
796 |             add_action('enqueue_block_assets', function () use ($instance): void {
797 |                 $this->assets($instance);
798 |             });
799 |         }
800 | 
801 |         return $this->view($this->view, [
802 |             'block' => $this,
803 |             'attributes' => $this->getComponentAttributeBag(),
804 |         ]);
805 |     }
806 | 
807 |     /**
808 |      * Assets enqueued when rendering the block.
809 |      *
810 |      * @return void
811 |      *
812 |      * @deprecated Use `assets($block)` instead.
813 |      */
814 |     public function enqueue()
815 |     {
816 |         //
817 |     }
818 | }
819 | 


--------------------------------------------------------------------------------