ILIAS  release_8 Revision v8.24
interface.ilCtrlPathInterface.php
Go to the documentation of this file.
1<?php
2
3/* Copyright (c) 2021 Thibeau Fuhrer <thf@studer-raimann.ch> Extended GPL, see docs/LICENSE */
4
14{
18 public const CID_PATH_SEPARATOR = ':';
19
28 public function getCidPath(): ?string;
29
35 public function getCurrentCid(): ?string;
36
43 public function getNextCid(string $current_class): ?string;
44
63 public function getCidPaths(int $order = SORT_DESC): array;
64
75 public function getCidArray(int $order = SORT_DESC): array;
76
82 public function getBaseClass(): ?string;
83
90 public function getException(): ?ilCtrlException;
91}
ilCtrl exceptions
Interface ilCtrlPathInterface is responsible for holding and manipulating a valid ilCtrl class-path (...
getCidArray(int $order=SORT_DESC)
Returns all cid's from the current path in the provided directory/order.
getBaseClass()
Returns the baseclass of the current cid path.
getCidPaths(int $order=SORT_DESC)
Returns all individual paths for each cid position for the given direction.
getException()
Returns the exception produced during the path-finding- process.
getCurrentCid()
Returns the CID that must currently be processed.
getNextCid(string $current_class)
Returns the next CID that must be processed.
getCidPath()
Returns the CID path for the target class of the current instance.