Fieldset.php

<?php

namespace Statamic\Fields;

use Statamic\Contracts\Query\ContainsQueryableValues;
use Statamic\Events\FieldsetCreated;
use Statamic\Events\FieldsetCreating;
use Statamic\Events\FieldsetDeleted;
use Statamic\Events\FieldsetDeleting;
use Statamic\Events\FieldsetReset;
use Statamic\Events\FieldsetSaved;
use Statamic\Events\FieldsetSaving;
use Statamic\Exceptions\FieldsetRecursionException;
use Statamic\Facades;
use Statamic\Facades\AssetContainer;
use Statamic\Facades\Collection;
use Statamic\Facades\Fieldset as FieldsetRepository;
use Statamic\Facades\File;
use Statamic\Facades\GlobalSet;
use Statamic\Facades\Path;
use Statamic\Facades\Taxonomy;
use Statamic\Support\Arr;
use Statamic\Support\Str;

class Fieldset implements ContainsQueryableValues
{
    protected $handle;
    protected $contents = [];
    protected $afterSaveCallbacks = [];
    protected $withEvents = true;
    protected $initialPath;

    public function setHandle(string $handle)
    {
        $this->handle = $handle;

        return $this;
    }

    public function handle(): ?string
    {
        return $this->handle;
    }

    public function path()
    {
        return Path::tidy(vsprintf('%s/%s.yaml', [
            Facades\Fieldset::directory(),
            str_replace('.', '/', $this->handle()),
        ]));
    }

    public function initialPath($path = null)
    {
        if (func_num_args() === 0) {
            return $this->initialPath;
        }

        $this->initialPath = $path;

        return $this;
    }

    public function setContents(array $contents)
    {
        $fields = Arr::get($contents, 'fields', []);

        // Support legacy syntax
        if (! empty($fields) && array_keys($fields)[0] !== 0) {
            $fields = collect($fields)->map(function ($field, $handle) {
                return compact('handle', 'field');
            })->values()->all();
        }

        $contents['fields'] = $fields;

        $this->contents = $contents;

        return $this;
    }

    public function contents(): array
    {
        return $this->contents;
    }

    public function title()
    {
        return $this->contents['title'] ?? Str::humanize(Str::of($this->handle)->after('::')->afterLast('.'));
    }

    /**
     * @throws FieldsetRecursionException
     */
    public function validateRecursion()
    {
        $this->fields();
    }

    public function fields(): Fields
    {
        $fields = Arr::get($this->contents, 'fields', []);

        return new Fields($fields);
    }

    public function field(string $handle): ?Field
    {
        return $this->fields()->get($handle);
    }

    public function hasField($field)
    {
        return $this->fields()->has($field);
    }

    public function isNamespaced(): bool
    {
        return Str::contains($this->handle(), '::');
    }

    public function namespace()
    {
        return $this->isNamespaced() ? Str::before($this->handle, '::') : null;
    }

    public function editUrl()
    {
        return cp_route('fieldsets.edit', $this->handle());
    }

    public function deleteUrl()
    {
        return cp_route('fieldsets.destroy', $this->handle());
    }

    public function resetUrl()
    {
        return cp_route('fieldsets.reset', $this->handle());
    }

    public function importedBy(): array
    {
        $blueprints = collect([
            ...Collection::all()->flatMap->entryBlueprints(),
            ...Taxonomy::all()->flatMap->termBlueprints(),
            ...GlobalSet::all()->map->blueprint(),
            ...AssetContainer::all()->map->blueprint(),
            ...Blueprint::in('')->values(),
        ])->filter()->filter(function (Blueprint $blueprint) {
            return collect($blueprint->contents()['tabs'])
                ->pluck('sections')
                ->flatten(1)
                ->pluck('fields')
                ->flatten(1)
                ->filter(fn ($field) => $field && $this->fieldImportsFieldset($field))
                ->isNotEmpty();
        })->values();

        $fieldsets = \Statamic\Facades\Fieldset::all()
            ->filter(fn (Fieldset $fieldset) => isset($fieldset->contents()['fields']))
            ->filter(function (Fieldset $fieldset) {
                return collect($fieldset->contents()['fields'])
                    ->filter(fn ($field) => $this->fieldImportsFieldset($field))
                    ->isNotEmpty();
            })
            ->values();

        return ['blueprints' => $blueprints, 'fieldsets' => $fieldsets];
    }

    private function fieldImportsFieldset(array $field): bool
    {
        if (isset($field['import'])) {
            return $field['import'] === $this->handle();
        }

        if (is_string($field['field'])) {
            return Str::before($field['field'], '.') === $this->handle();
        }

        if (isset($field['field']['fields'])) {
            return collect($field['field']['fields'])
                ->filter(fn ($field) => $this->fieldImportsFieldset($field))
                ->isNotEmpty();
        }

        if (isset($field['field']['sets'])) {
            return collect($field['field']['sets'])
                ->filter(fn ($setGroup) => isset($setGroup['sets']))
                ->filter(function ($setGroup) {
                    return collect($setGroup['sets'])->filter(function ($set) {
                        return collect($set['fields'])
                            ->filter(fn ($field) => $this->fieldImportsFieldset($field))
                            ->isNotEmpty();
                    })->isNotEmpty();
                })
                ->isNotEmpty();
        }

        return false;
    }

    public function isDeletable()
    {
        return ! $this->isNamespaced();
    }

    public function isResettable()
    {
        return $this->isNamespaced()
            && File::exists(FieldsetRepository::overriddenNamespacedFieldsetPath($this->handle));
    }

    public function afterSave($callback)
    {
        $this->afterSaveCallbacks[] = $callback;

        return $this;
    }

    public function saveQuietly()
    {
        $this->withEvents = false;

        return $this->save();
    }

    public function save()
    {
        $isNew = is_null(Facades\Fieldset::find($this->handle()));

        $withEvents = $this->withEvents;
        $this->withEvents = true;

        $afterSaveCallbacks = $this->afterSaveCallbacks;
        $this->afterSaveCallbacks = [];

        if ($withEvents) {
            if ($isNew && FieldsetCreating::dispatch($this) === false) {
                return false;
            }

            if (FieldsetSaving::dispatch($this) === false) {
                return false;
            }
        }

        FieldsetRepository::save($this);

        foreach ($afterSaveCallbacks as $callback) {
            $callback($this);
        }

        if ($withEvents) {
            if ($isNew) {
                FieldsetCreated::dispatch($this);
            }

            FieldsetSaved::dispatch($this);
        }

        return $this;
    }

    public function deleteQuietly()
    {
        $this->withEvents = false;

        return $this->delete();
    }

    public function delete()
    {
        $withEvents = $this->withEvents;
        $this->withEvents = true;

        if ($withEvents && FieldsetDeleting::dispatch($this) === false) {
            return false;
        }

        FieldsetRepository::delete($this);

        if ($withEvents) {
            FieldsetDeleted::dispatch($this);
        }

        return true;
    }

    public function reset()
    {
        FieldsetRepository::reset($this);

        FieldsetReset::dispatch($this);

        return true;
    }

    public function getQueryableValue(string $field)
    {
        if (in_array($method = Str::camel($field), $this->queryableMethods())) {
            return $this->{$method}();
        }

        return null;
    }

    private function queryableMethods(): array
    {
        return [
            'editUrl', 'fields', 'handle', 'isDeletable', 'isResettable',
            'namespace', 'path', 'title',
        ];
    }

    public static function __callStatic($method, $parameters)
    {
        return Facades\Fieldset::{$method}(...$parameters);
    }
}