<?php

namespace AOP\App\Fields;

/**
 * Builders for the entries of FieldType::settings(). Each entry is a plain array:
 *
 *   key       the key in the stored field (page_value.pages[].fields[])
 *   control   how the editor asks for it: text, textarea, number, toggle, select, choices, extensions, color
 *   label     shown in the editor
 *   default   what the editor starts with
 *   sanitize  a name from Sanitize, ['in', [...]], or a callable fn($value, array $raw, Validation $v)
 *   from      key in the posted field when it differs from `key` (only page_name)
 *   value     a fixed value that is always stored
 *   derive    callable fn(array $sanitized, array $raw) that computes the value from the other settings
 *   options   the choices of a select control
 *
 * @since 1.0.0
 * Part of the Field Types API (docs/field-types-api.md), stable since 1.0.0 and semantically versioned.
 */
final class Setting
{
    /**
     * @param string|array|callable $sanitize A name from Sanitize, ['in', [...]] or a callable.
     */
    public static function make(string $key, string $control, string $label, $sanitize, $default = '', array $extra = []): array
    {
        return array_merge([
            'key' => $key,
            'control' => $control,
            'label' => $label,
            'default' => $default,
            'sanitize' => $sanitize,
        ], $extra);
    }

    public static function fixed(string $key, $value): array
    {
        return ['key' => $key, 'control' => null, 'value' => $value];
    }

    /**
     * A value that follows from the other settings (for example the default of a list is its first choice).
     *
     * @param callable $derive fn(array $sanitizedSoFar, array $raw)
     */
    public static function derived(string $key, callable $derive): array
    {
        return ['key' => $key, 'control' => null, 'derive' => $derive];
    }

    public static function label(): array
    {
        return self::make('field_label', 'text', __('Field label', 'admin-options-pages'), 'text');
    }

    public static function name(): array
    {
        return self::make('field_name', 'text', __('Field name', 'admin-options-pages'), 'field_name');
    }

    public static function autoload(): array
    {
        return self::make('toggle_autoload', 'toggle', __('Autoload', 'admin-options-pages'), 'toggle_autoload', 'yes');
    }

    /**
     * Whether the value may be shown through the shortcode and the block bindings: "yes" or "no". A field that was
     * stored without this key (made before 1.0) counts as "no". get_option() works for every field either way.
     *
     * @since 1.0.0
     */
    public static function frontend(): array
    {
        return self::make('frontend', 'toggle', __('Use in shortcode and blocks', 'admin-options-pages'), 'toggle_frontend', 'yes');
    }

    public static function classAttribute(): array
    {
        return self::make('class_attribute', 'text', __('Additional CSS Class(es)', 'admin-options-pages'), 'class_attribute');
    }

    public static function description(): array
    {
        return self::make('description', 'textarea', __('Description', 'admin-options-pages'), 'textarea');
    }

    public static function defaultText(): array
    {
        return self::make('default_value', 'text', __('Default value', 'admin-options-pages'), 'text');
    }

    public static function text(string $key, string $label): array
    {
        return self::make($key, 'text', $label, 'text');
    }
}