interface.ilCtrlStructureInterface.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2021 Thibeau Fuhrer <thf@studer-raimann.ch> Extended GPL, see docs/LICENSE */

interface ilCtrlStructureInterface
{
    public const KEY_CLASS_CID = 'cid';
    public const KEY_CLASS_PATH = 'class_path';
    public const KEY_CLASS_NAME = 'class_name';
    public const KEY_CLASS_CID_PATHS = 'cid_paths';
    public const KEY_CLASS_PARENTS = 'parents';
    public const KEY_CLASS_CHILDREN = 'children';
    public const KEY_UNSAFE_COMMANDS = 'unsafe_commands';
    public const KEY_SAFE_COMMANDS = 'safe_commands';

    public function isBaseClass(string $class_name): bool;

    public function getObjNameByCid(string $cid): ?string;

    public function getObjNameByName(string $class_name): ?string;

    public function getClassNameByCid(string $cid): ?string;

    public function getClassCidByName(string $class_name): ?string;

    public function getRelativePathByName(string $class_name): ?string;

    public function getRelativePathByCid(string $cid): ?string;

    public function getChildrenByCid(string $cid): ?array;

    public function getChildrenByName(string $class_name): ?array;

    public function getParentsByCid(string $cid): ?array;

    public function getParentsByName(string $class_name): ?array;

    public function setPermanentParameterByClass(string $class_name, string $parameter_name): void;

    public function removePermanentParametersByClass(string $class_name): void;

    public function getPermanentParametersByClass(string $class_name): ?array;

    public function setTemporaryParameterByClass(string $class_name, string $parameter_name, $value): void;

    public function removeTemporaryParametersByClass(string $class_name): void;

    public function getTemporaryParametersByClass(string $class_name): ?array;

    public function removeSingleParameterByClass(string $class_name, string $parameter_name): void;

    public function setReturnTargetByClass(string $class_name, string $target_url): void;

    public function getReturnTargetByClass(string $class_name): ?string;

    public function getUnsafeCommandsByCid(string $cid): array;

    public function getUnsafeCommandsByName(string $class_name): array;

    public function getSafeCommandsByCid(string $cid): array;

    public function getSafeCommandsByName(string $class_name): array;
}