BooleanSchemaDefinition.php

<?php

/*
 * This file is part of the official PHP MCP SDK.
 *
 * A collaboration between Symfony and the PHP Foundation.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Mcp\Schema\Elicitation;

/**
 * Schema definition for boolean fields in elicitation requests.
 *
 * @author Johannes Wachter <johannes@sulu.io>
 */
final class BooleanSchemaDefinition extends AbstractSchemaDefinition
{
    /**
     * @param string      $title       Human-readable title for the field
     * @param string|null $description Optional description/help text
     * @param bool|null   $default     Optional default value
     */
    public function __construct(
        string $title,
        ?string $description = null,
        public readonly ?bool $default = null,
    ) {
        parent::__construct($title, $description);
    }

    /**
     * @param array{
     *     title: string,
     *     description?: string,
     *     default?: bool,
     * } $data
     */
    public static function fromArray(array $data): self
    {
        self::validateTitle($data, 'boolean');

        return new self(
            title: $data['title'],
            description: $data['description'] ?? null,
            default: isset($data['default']) ? (bool) $data['default'] : null,
        );
    }

    /**
     * @return array{
     *     type: string,
     *     title: string,
     *     description?: string,
     *     default?: bool,
     * }
     */
    public function jsonSerialize(): array
    {
        $data = $this->buildBaseJson('boolean');

        if (null !== $this->default) {
            $data['default'] = $this->default;
        }

        return $data;
    }
}