ILIAS\Refinery\Parser\ABNF\Intermediate Class Reference

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

Public Member Functions
	__construct (string $todo, array $accepted=[])
	value ()
	accept ()
	push (array $values)
	reject ()
	accepted ()
	done ()
	onlyTodo ()
	transform (Closure $transform)
	Calls the given closure with all accepted values. More...

Private Attributes
string	$todo
array	$accepted

Detailed Description

Definition at line 28 of file Intermediate.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Refinery\Parser\ABNF\Intermediate::__construct	(	string	$todo,
		array	$accepted = []
	)

Definition at line 33 of file Intermediate.php.

References ILIAS\Refinery\Parser\ABNF\Intermediate\$accepted, ILIAS\Refinery\Parser\ABNF\Intermediate\$todo, and ILIAS\Refinery\Parser\ABNF\Intermediate\accepted().

    {
        $this->todo = $todo;
        $this->accepted = $accepted;
    }

Here is the call graph for this function:

Member Function Documentation

accept()

ILIAS\Refinery\Parser\ABNF\Intermediate::accept

(

)

Definition at line 44 of file Intermediate.php.

References ILIAS\Refinery\Parser\ABNF\Intermediate\accepted(), and ILIAS\Refinery\Parser\ABNF\Intermediate\push().

Referenced by ILIAS\Refinery\Parser\ABNF\Primitives\eq(), ILIAS\Refinery\Parser\ABNF\Brick\range(), ILIAS\Tests\Refinery\Parser\ABNF\TransformTest\testAs(), ILIAS\Tests\Refinery\Parser\ABNF\TransformTest\testFailedToTransform(), and ILIAS\Tests\Refinery\Parser\ABNF\TransformTest\testTo().

                            : Result
    {
        return new Ok((new self(
            substr($this->todo, 1),
            $this->accepted()
        ))->push([new Character(substr($this->todo, 0, 1))]));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

accepted()

ILIAS\Refinery\Parser\ABNF\Intermediate::accepted

(

)

Definition at line 65 of file Intermediate.php.

References ILIAS\Refinery\Parser\ABNF\Intermediate\$accepted.

Referenced by ILIAS\Refinery\Parser\ABNF\Intermediate\__construct(), ILIAS\Refinery\Parser\ABNF\Intermediate\accept(), ILIAS\Refinery\Parser\ABNF\Transform\combine(), ILIAS\Refinery\Parser\ABNF\Intermediate\push(), ILIAS\Tests\Refinery\Parser\ABNF\TransformTest\testAs(), and ILIAS\Refinery\Parser\ABNF\Intermediate\transform().

                              : array
    {
        return $this->accepted;
    }

Here is the caller graph for this function:

done()

ILIAS\Refinery\Parser\ABNF\Intermediate::done

(

)

Definition at line 70 of file Intermediate.php.

References ILIAS\Refinery\Parser\ABNF\Intermediate\$todo.

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

                          : bool
    {
        return '' === $this->todo;
    }

Here is the caller graph for this function:

onlyTodo()

ILIAS\Refinery\Parser\ABNF\Intermediate::onlyTodo

(

)

Definition at line 75 of file Intermediate.php.

References ILIAS\Refinery\Parser\ABNF\Intermediate\$todo.

Referenced by ILIAS\Refinery\Parser\ABNF\Transform\combine(), and ILIAS\Refinery\Parser\ABNF\Transform\from().

                              : self
    {
        return new self($this->todo);
    }

Here is the caller graph for this function:

push()

ILIAS\Refinery\Parser\ABNF\Intermediate::push

(

array

$values

)

Definition at line 52 of file Intermediate.php.

References ILIAS\Refinery\Parser\ABNF\Intermediate\$todo, and ILIAS\Refinery\Parser\ABNF\Intermediate\accepted().

Referenced by ILIAS\Refinery\Parser\ABNF\Intermediate\accept().

                                       : self
    {
        return new self(
            $this->todo,
            array_merge($this->accepted, $values)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reject()

ILIAS\Refinery\Parser\ABNF\Intermediate::reject

(

)

Definition at line 60 of file Intermediate.php.

Referenced by ILIAS\Refinery\Parser\ABNF\Primitives\eq(), ILIAS\Refinery\Parser\ABNF\Brick\range(), and ILIAS\Tests\Refinery\Parser\ABNF\TransformTest\testFailedToParse().

                            : Result
    {
        return new Error('Rejected.');
    }

Here is the caller graph for this function:

transform()

ILIAS\Refinery\Parser\ABNF\Intermediate::transform

(

Closure

$transform

)

Calls the given closure with all accepted values.

For convenience the $accepted values are transformed to a string when they are a Character[]. Unprocessed characters are wrapped with the Character class to prevent the need for a conversion from a character list (e.g. ['a', 'b'] ) to a string ("ab"), because it's not nice to operate on single length string lists instead of strings.

A

Parameters

Closure(string|A[])

Result $transform

Returns

Result

Definition at line 89 of file Intermediate.php.

References $data, and ILIAS\Refinery\Parser\ABNF\Intermediate\accepted().

Referenced by ILIAS\Refinery\Parser\ABNF\Brick\apply(), and ILIAS\Refinery\Parser\ABNF\Transform\from().

                                                 : Result
    {
        $string = '';
        foreach ($this->accepted as $data) {
            if (!$data instanceof Character) {
                return $transform($this->accepted);
            }
            $string .= $data->value();
        }

        return $transform($string);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

value()

ILIAS\Refinery\Parser\ABNF\Intermediate::value

(

)

Definition at line 39 of file Intermediate.php.

Referenced by ILIAS\Refinery\Parser\ABNF\Primitives\eq(), and ILIAS\Refinery\Parser\ABNF\Brick\range().

                           : int
    {
        return ord($this->todo);
    }

Here is the caller graph for this function:

Field Documentation

$accepted

array ILIAS\Refinery\Parser\ABNF\Intermediate::$accepted

private

Definition at line 31 of file Intermediate.php.

Referenced by ILIAS\Refinery\Parser\ABNF\Intermediate\__construct(), and ILIAS\Refinery\Parser\ABNF\Intermediate\accepted().

$todo

string ILIAS\Refinery\Parser\ABNF\Intermediate::$todo

private

Definition at line 30 of file Intermediate.php.

Referenced by ILIAS\Refinery\Parser\ABNF\Intermediate\__construct(), ILIAS\Refinery\Parser\ABNF\Intermediate\done(), ILIAS\Refinery\Parser\ABNF\Intermediate\onlyTodo(), and ILIAS\Refinery\Parser\ABNF\Intermediate\push().

---

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

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