ILIAS\Refinery\Parser\ABNF\Brick Class Reference

@phpstan-type Continuation Closure(Result<Intermediate>): Result<Intermediate> @phpstan-type Parser Closure(Intermediate, Continuation): Result<Intermediate> More...

Collaboration diagram for ILIAS\Refinery\Parser\ABNF\Brick:

Public Member Functions
	__construct ()
	apply (Closure $parse, string $input)
	toTransformation (Closure $parse)
	range (int $start, int $end)
	alpha ()
	digit ()
	either (array $parsers)
	sequence (array $parsers)
	repeat (int $min, ?int $max, $parse)
	transformation (Transformation $transformation, Closure $parse)

Private Member Functions
	namesFromKeys (array $array)
	consume (Closure $parse, Intermediate $intermediate)
	It just checks if the given input is fully consumed after parsing and rejects the input otherwise. More...

Private Attributes
Transform	$transform
Primitives	$primitives

Detailed Description

@phpstan-type Continuation Closure(Result<Intermediate>): Result<Intermediate> @phpstan-type Parser Closure(Intermediate, Continuation): Result<Intermediate>

Definition at line 34 of file Brick.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Refinery\Parser\ABNF\Brick::__construct

(

)

Definition at line 39 of file Brick.php.

    {
        $this->transform = new Transform();
        $this->primitives = new Primitives();
    }

References ILIAS\Refinery\transform().

Here is the call graph for this function:

Member Function Documentation

alpha()

ILIAS\Refinery\Parser\ABNF\Brick::alpha

(

)

Returns

Parser

Definition at line 78 of file Brick.php.

                           : Closure
    {
        return $this->primitives->simpleEither([
            $this->range(0x41, 0x5A),
            $this->range(0x61, 0x7A),
        ]);
    }

References ILIAS\Refinery\Parser\ABNF\Brick\range().

Referenced by ILIAS\Data\LanguageTag\definition().

Here is the call graph for this function:

Here is the caller graph for this function:

apply()

ILIAS\Refinery\Parser\ABNF\Brick::apply	(	Closure	$parse,
		string	$input
	)

Definition at line 45 of file Brick.php.

                                                        : Result
    {
        return $this->consume($parse, new Intermediate($input))->then(static fn(Intermediate $x): Result => (
            $x->transform(static fn($value): Result => (
                new Ok(is_array($value) && !is_string(key($value)) ? current($value) : $value)
            ))
        ));
    }

References ILIAS\Refinery\Parser\ABNF\Brick\consume(), and ILIAS\Refinery\Parser\ABNF\Intermediate\transform().

Referenced by ILIAS\Refinery\Parser\ABNF\Brick\toTransformation().

Here is the call graph for this function:

Here is the caller graph for this function:

consume()

ILIAS\Refinery\Parser\ABNF\Brick::consume ( Closure  $parse, Intermediate  $intermediate  )

private

It just checks if the given input is fully consumed after parsing and rejects the input otherwise.

Parameters

Parser	$parse
Intermediate	$intermediate

Returns

Result<Intermediate>

Definition at line 157 of file Brick.php.

                                                                        : Result
    {
        return $parse($intermediate, static fn(Result $x): Result => $x->then(
            static fn(Intermediate $x): Result => $x->done() ? new Ok($x) : new Error('EOF not reached.')
        ));
    }

References ILIAS\Data\Result\then().

Referenced by ILIAS\Refinery\Parser\ABNF\Brick\apply().

Here is the call graph for this function:

Here is the caller graph for this function:

digit()

ILIAS\Refinery\Parser\ABNF\Brick::digit

(

)

Returns

Parser

Definition at line 89 of file Brick.php.

                           : Closure
    {
        return $this->range(0x30, 0x39);
    }

References ILIAS\Refinery\Parser\ABNF\Brick\range().

Referenced by ILIAS\Data\LanguageTag\definition().

Here is the call graph for this function:

Here is the caller graph for this function:

either()

ILIAS\Refinery\Parser\ABNF\Brick::either

(

array

$parsers

)

Definition at line 94 of file Brick.php.

                                          : Closure
    {
        return $this->primitives->simpleEither($this->namesFromKeys($parsers));
    }

References ILIAS\Refinery\Parser\ABNF\Brick\namesFromKeys().

Referenced by ILIAS\Data\LanguageTag\definition().

Here is the call graph for this function:

Here is the caller graph for this function:

namesFromKeys()

ILIAS\Refinery\Parser\ABNF\Brick::namesFromKeys ( array  $array )

private

Parameters

array<(string|int),(string|Parser)>

$array

Returns

Parser[]

Definition at line 139 of file Brick.php.

                                                : array
    {
        return array_map(
            function ($key) use ($array): Closure {
                $current = $this->primitives->parserFrom($array[$key]);
                return is_string($key) ? $this->transform->as($key, $current) : $current;
            },
            array_keys($array)
        );
    }

References ILIAS\Refinery\transform().

Referenced by ILIAS\Refinery\Parser\ABNF\Brick\either(), and ILIAS\Refinery\Parser\ABNF\Brick\sequence().

Here is the call graph for this function:

Here is the caller graph for this function:

range()

ILIAS\Refinery\Parser\ABNF\Brick::range	(	int	$start,
		int	$end
	)

Parameters

int	$start
int	$end

Returns

Parser

Definition at line 68 of file Brick.php.

                                               : Closure
    {
        return static fn(Intermediate $x, Closure $cc): Result => $cc(
            $x->value() >= $start && $x->value() <= $end ? $x->accept() : $x->reject()
        );
    }

References ILIAS\Refinery\Parser\ABNF\Intermediate\accept(), ILIAS\Refinery\Parser\ABNF\Intermediate\reject(), and ILIAS\Refinery\Parser\ABNF\Intermediate\value().

Referenced by ILIAS\Refinery\Parser\ABNF\Brick\alpha(), ILIAS\Data\LanguageTag\definition(), and ILIAS\Refinery\Parser\ABNF\Brick\digit().

Here is the call graph for this function:

Here is the caller graph for this function:

repeat()

ILIAS\Refinery\Parser\ABNF\Brick::repeat	(	int	$min,
		?int	$max,
			$parse
	)

Parameters

int	$min
null | int	$max
Parser | string	$parse

Returns

Parser

Definition at line 114 of file Brick.php.

                                                       : Closure
    {
        $min = max(0, $min);
        $max = null === $max ? null : max($min, $max) - $min;
 
        return $this->primitives->simpleSequence([
            ...array_fill(0, $min, $parse),
            $this->primitives->until($max, $parse)
        ]);
    }

Referenced by ILIAS\Data\LanguageTag\definition().

Here is the caller graph for this function:

sequence()

ILIAS\Refinery\Parser\ABNF\Brick::sequence

(

array

$parsers

)

Parameters

(Parser|string)[]

$parse

Returns

Parser

Definition at line 103 of file Brick.php.

                                            : Closure
    {
        return $this->primitives->simpleSequence($this->namesFromKeys($parsers));
    }

References ILIAS\Refinery\Parser\ABNF\Brick\namesFromKeys().

Referenced by ILIAS\Data\LanguageTag\definition().

Here is the call graph for this function:

Here is the caller graph for this function:

toTransformation()

ILIAS\Refinery\Parser\ABNF\Brick::toTransformation

(

Closure

$parse

)

Parameters

Parser

$parse

Returns

Transformation

Definition at line 58 of file Brick.php.

                                                    : Transformation
    {
        return new Custom(fn($input) => $this->apply($parse, $input)->value());
    }

References ILIAS\Refinery\Parser\ABNF\Brick\apply().

Here is the call graph for this function:

transformation()

ILIAS\Refinery\Parser\ABNF\Brick::transformation	(	Transformation	$transformation,
		Closure	$parse
	)

Parameters

Transformation	$transformation
Parser	$parser

Returns

Parser

Definition at line 130 of file Brick.php.

                                                                                  : Closure
    {
        return $this->transform->to($transformation, $parse);
    }

References ILIAS\Refinery\transform().

Referenced by ILIAS\Data\LanguageTag\definition().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$primitives

Primitives ILIAS\Refinery\Parser\ABNF\Brick::$primitives

private

Definition at line 37 of file Brick.php.

$transform

Transform ILIAS\Refinery\Parser\ABNF\Brick::$transform

private

Definition at line 36 of file Brick.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/Refinery/src/Parser/ABNF/Brick.php