BuilderInterface.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\MetaData\Paths;

use ILIAS\MetaData\Paths\Filters\FilterType;
use ILIAS\MetaData\Paths\Steps\StepInterface;
use ILIAS\MetaData\Structure\Definitions\DefinitionInterface;
use ILIAS\MetaData\Paths\Steps\StepToken;

interface BuilderInterface
{
    public function withRelative(bool $is_relative): BuilderInterface;

    public function withLeadsToExactlyOneElement(
        bool $leads_to_one
    ): BuilderInterface;

    public function withNextStep(
        string $name,
        bool $add_as_first = false
    ): BuilderInterface;

    public function withNextStepToSuperElement(
        bool $add_as_first = false
    ): BuilderInterface;

    public function withAdditionalFilterAtCurrentStep(
        FilterType $type,
        string ...$values
    ): BuilderInterface;

    public function get(): PathInterface;

    public function withNextStepFromStep(
        StepInterface $next_step,
        bool $add_as_first = false
    ): BuilderInterface;
}