ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: home / thebhoeo / .trash / backwpup / vendor / wordpress / php-mcp-schema / src / Client / Elicitation / DTO

<?php

declare(strict_types=1);

namespace WP\McpSchema\Client\Elicitation\DTO;

use WP\McpSchema\Client\Lifecycle\Union\ClientResultInterface;
use WP\McpSchema\Common\Protocol\DTO\Result;
use WP\McpSchema\Common\Traits\ValidatesRequiredFields;

/**
 * The client's response to an elicitation request.
 *
 * @since 2025-06-18
 *
 * @mcp-domain Client
 * @mcp-subdomain Elicitation
 * @mcp-version 2025-11-25
 */
class ElicitResult extends Result implements ClientResultInterface
{
    use ValidatesRequiredFields;

/**
     * The user action in response to the elicitation.
     * - "accept": User submitted the form/confirmed the action
     * - "decline": User explicitly decline the action
     * - "cancel": User dismissed without making an explicit choice
     *
     * @since 2025-06-18
     *
     * @var 'accept'|'decline'|'cancel'
     */
    protected string $action;

/**
     * The submitted form data, only present when action is "accept" and mode was "form".
     * Contains values matching the requested schema.
     * Omitted for out-of-band mode responses.
     *
     * @since 2025-06-18
     *
     * @var array<string, string>|null
     */
    protected ?array $content;

/**
     * @param 'accept'|'decline'|'cancel' $action @since 2025-06-18
     * @param array<string, mixed>|null $_meta @since 2025-06-18
     * @param array<string, string>|null $content @since 2025-06-18
     */
    public function __construct(
        string $action,
        ?array $_meta = null,
        ?array $content = null
    ) {
        parent::__construct($_meta);
        $this->action = $action;
        $this->content = $content;
    }

/**
     * Creates an instance from an array.
     *
     * @param array{
     *     _meta?: array<string, mixed>|null,
     *     action: 'accept'|'decline'|'cancel',
     *     content?: array<string, string>|null
     * } $data
     * @phpstan-param array<string, mixed> $data
     * @return self
     */
    public static function fromArray(array $data): self
    {
        self::assertRequired($data, ['action']);

/** @var 'accept'|'decline'|'cancel' $action */
        $action = self::asString($data['action']);

return new self(
            $action,
            self::asArrayOrNull($data['_meta'] ?? null),
            self::asStringMapOrNull($data['content'] ?? null)
        );
    }

/**
     * Converts the instance to an array.
     *
     * @return array<string, mixed>
     */
    public function toArray(): array
    {
        $result = parent::toArray();

$result['action'] = $this->action;
        if ($this->content !== null) {
            $result['content'] = $this->content;
        }

return $result;
    }

/**
     * @return 'accept'|'decline'|'cancel'
     */
    public function getAction(): string
    {
        return $this->action;
    }

/**
     * @return array<string, string>|null
     */
    public function getContent(): ?array
    {
        return $this->content;
    }
}

[-] BooleanSchema.php [edit]
[-] ElicitResult.php [edit]
[-] ElicitRequestURLParams.php [edit]
[-] LegacyTitledEnumSchema.php [edit]
[-] TitledMultiSelectEnumSchemaItems.php [edit]
[-] ElicitRequestFormParams.php [edit]
[-] ElicitationCompleteNotification.php [edit]
[-] NumberSchema.php [edit]
[-] TitledSingleSelectEnumSchema.php [edit]
[+] ..
[-] UntitledMultiSelectEnumSchema.php [edit]
[-] StringSchema.php [edit]
[-] ElicitationCompleteNotificationParams.php [edit]
[-] ElicitRequest.php [edit]
[-] UntitledMultiSelectEnumSchemaItems.php [edit]
[-] TitledMultiSelectEnumSchema.php [edit]
[-] UntitledSingleSelectEnumSchema.php [edit]
[-] ElicitRequestFormParamsRequestedSchema.php [edit]