class.StandardGUIRequest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Container;

use ILIAS\Repository;

class StandardGUIRequest
{
    use Repository\BaseGUIRequest;

    public function __construct(
        \ILIAS\HTTP\Services $http,
        \ILIAS\Refinery\Factory $refinery
    ) {
        $this->initRequest(
            $http,
            $refinery
        );
    }

    public function getRefId(): int
    {
        return $this->int("ref_id");
    }

    public function getItemRefId(): int
    {
        return $this->int("item_ref_id");
    }

    public function getRedirectSource(): string
    {
        return $this->str("redirectSource");
    }

    public function getNewType(): string
    {
        return $this->str("new_type");
    }

    public function getType(): string
    {
        return $this->str("type");
    }

    public function getBaseClass(): string
    {
        return $this->str("baseClass");
    }

    public function getSelectedIds(): array
    {
        if ($this->int("item_ref_id") > 0) {
            $ids = [$this->int("item_ref_id")];
        } else {
            $ids = $this->intArray("id");
        }
        return $ids;
    }

    public function getCloneSource(): int
    {
        return $this->int("clone_source");
    }

    public function getCmdRefId(): int
    {
        return $this->int("cmdrefid");
    }

    public function getChildRefId(): int
    {
        return $this->int("child_ref_id");
    }

    public function getParentRefId(): int
    {
        return $this->int("parent_ref_id");
    }

    public function getExpand(): int
    {
        return $this->int("expand");
    }

    public function getBlockAction(): string
    {
        return $this->str("act");
    }

    public function getBlockId(): string
    {
        return $this->str("cont_block_id");
    }

    public function getPreviousSession(): ?int
    {
        if ($this->http->wrapper()->query()->has('crs_prev_sess')) {
            return $this->int("crs_prev_sess");
        }
        return null;
    }

    public function getNextSession(): ?int
    {
        if ($this->http->wrapper()->query()->has('crs_next_sess')) {
            return $this->int("crs_next_sess");
        }
        return null;
    }

    public function getObjectiveId(): int
    {
        return $this->int("oobj");
    }

    public function getNodes(): array
    {
        if ($this->int("node") > 0) {
            return [$this->int("node")];
        }
        return $this->intArray("nodes");
    }

    public function getCopyOptions(): array
    {
        return $this->arrayArray("cp_options");
    }

    public function getPositions(): array
    {
        // note: the position parameter is currently
        // quite unstructured typewise, array of array|string
        $body = $this->http->request()->getParsedBody();
        return $body["position"] ?? [];
        //return $this->arrayArray("position");
    }

    public function getTrashIds(): array
    {
        return $this->intArray("trash_id");
    }

    public function getAlreadyRenderedRefIds(): array
    {
        $ids = $this->strArray("ids");
        $ref_ids = array_map(static function (string $i): int {
            $parts = explode("_", $i);
            return (int) $parts[2];
        }, $ids);
        return $ref_ids;
    }

    public function getStartObjPositions(): array
    {
        return $this->intArray("pos");
    }

    public function getStartObjIds(): array
    {
        return $this->intArray("starter");
    }

    public function getCmdClass(): string
    {
        return $this->str("cmdClass");
    }
}