vendor/bakame/http-structured-fields/src/StructuredFieldProvider.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

<?php

declare(strict_types=1);

namespace Bakame\Http\StructuredFields;

use DateTimeImmutable;
use DateTimeInterface;

/**
 * @phpstan-type SfType Bytes|Token|DisplayString|DateTimeImmutable|string|int|float|bool
 * @phpstan-type SfTypeInput SfType|DateTimeInterface
 * @phpstan-type SfList InnerList|OuterList
 * @phpstan-type SfOrderedMap Dictionary|Parameters
 * @phpstan-type SfDataType SfList|SfOrderedMap|Item
 * @phpstan-type SfItemInput SfTypeInput|SfDataType|StructuredFieldProvider
 * @phpstan-type SfMemberInput iterable<SfItemInput>|SfItemInput
 * @phpstan-type SfParameterInput iterable<array{0:string, 1?:SfItemInput}>
 * @phpstan-type SfInnerListPair array{0:iterable<SfItemInput>, 1?:Parameters|SfParameterInput}
 * @phpstan-type SfItemPair array{0:SfTypeInput, 1?:Parameters|SfParameterInput}
 */
interface StructuredFieldProvider
{
    /**
     * Returns one of the StructuredField Data Type class.
     */
    public function toStructuredField(): Dictionary|InnerList|Item|OuterList|Parameters;
}