class.ilCtrlContext.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Refinery\Factory as Refinery;
use ILIAS\HTTP\Wrapper\RequestWrapper;

class ilCtrlContext implements ilCtrlContextInterface
{
    protected ilCtrlPathFactory $path_factory;

    protected RequestWrapper $request_wrapper;

    protected Refinery $refinery;

    protected ilCtrlPathInterface $path;

    protected bool $is_async = false;

    protected string $target_script = 'ilias.php';

    protected ?string $cmd_mode = null;

    protected ?string $redirect = null;

    protected ?string $base_class = null;

    protected ?string $cmd_class = null;

    protected ?string $cmd = null;

    protected ?string $obj_type = null;

    protected ?int $obj_id = null;

    public function __construct(ilCtrlPathFactory $path_factory, RequestWrapper $request_wrapper, Refinery $refinery)
    {
        $this->path_factory = $path_factory;
        $this->path = $path_factory->null();
        $this->request_wrapper = $request_wrapper;
        $this->refinery = $refinery;

        $this->adoptRequestParameters();
    }

    public function isAsync(): bool
    {
        return $this->is_async;
    }

    public function getRedirectSource(): ?string
    {
        return $this->redirect;
    }

    public function getPath(): ilCtrlPathInterface
    {
        return $this->path;
    }

    public function setCmdMode(string $mode): ilCtrlContextInterface
    {
        $this->cmd_mode = $mode;
        return $this;
    }

    public function getCmdMode(): ?string
    {
        return $this->cmd_mode;
    }

    public function setBaseClass(string $base_class): ilCtrlContextInterface
    {
        $path = $this->path_factory->find($this, $base_class);

        // only set baseclass if it's a valid target.
        if (null !== $path->getCidPath()) {
            $this->base_class = $base_class;
            // only update the path if the current one is null.
            if (null === $this->path->getCidPath()) {
                $this->path = $path;
            }
        }

        return $this;
    }

    public function getBaseClass(): ?string
    {
        return $this->base_class;
    }

    public function setTargetScript(string $target_script): ilCtrlContextInterface
    {
        $this->target_script = $target_script;
        return $this;
    }

    public function getTargetScript(): string
    {
        return $this->target_script;
    }

    public function setCmdClass(?string $cmd_class): ilCtrlContextInterface
    {
        $path = $this->path_factory->find($this, $cmd_class);

        // only set command class if it's a valid target.
        if (null !== $path->getCidPath()) {
            $this->cmd_class = $cmd_class;
            $this->path = $path;
        }

        return $this;
    }

    public function getCmdClass(): ?string
    {
        // if no cmd_class is set yet, the baseclass
        // value can be returned.
        return $this->cmd_class ?? $this->base_class;
    }

    public function setCmd(?string $cmd): ilCtrlContextInterface
    {
        $this->cmd = $cmd;

        return $this;
    }

    public function getCmd(): ?string
    {
        return $this->cmd;
    }

    public function setObjType(string $obj_type): ilCtrlContextInterface
    {
        $this->obj_type = $obj_type;
        return $this;
    }

    public function getObjType(): ?string
    {
        return $this->obj_type;
    }

    public function setObjId(int $obj_id): ilCtrlContextInterface
    {
        $this->obj_id = $obj_id;
        return $this;
    }

    public function getObjId(): ?int
    {
        return $this->obj_id;
    }

    protected function adoptRequestParameters(): void
    {
        $this->redirect = $this->getQueryParam(ilCtrlInterface::PARAM_REDIRECT);
        $this->cmd_mode = $this->getQueryParam(ilCtrlInterface::PARAM_CMD_MODE);
        $this->cmd = $this->getQueryParam(ilCtrlInterface::PARAM_CMD);

        // the context is considered asynchronous if
        // the command mode is 'async'.
        if (ilCtrlInterface::CMD_MODE_ASYNC === $this->cmd_mode) {
            $this->is_async = true;
        }

        // if an existing path is provided use it by default.
        $existing_path = $this->getQueryParam(ilCtrlInterface::PARAM_CID_PATH);
        if (null !== $existing_path) {
            $this->path = $this->path_factory->existing($existing_path);
        }

        // set the provided baseclass, which might override the
        // previously set existing path.
        $base_class = $this->getQueryParam(ilCtrlInterface::PARAM_BASE_CLASS);
        if (null !== $base_class) {
            $this->setBaseClass($base_class);
        }

        // set or append the provided command class, which might
        // override the previously set path again.
        $cmd_class = $this->getQueryParam(ilCtrlInterface::PARAM_CMD_CLASS);
        if (null !== $cmd_class) {
            $this->setCmdClass($cmd_class);
        }
    }

    protected function getQueryParam(string $parameter_name): ?string
    {
        if ($this->request_wrapper->has($parameter_name)) {
            return $this->request_wrapper->retrieve(
                $parameter_name,
                $this->refinery->to()->string()
            );
        }

        return null;
    }
}