ILIAS\GlobalScreen\GUI\Flow\Flow Class Reference

Collaboration diagram for ILIAS\GlobalScreen\GUI\Flow\Flow:

Public Member Functions
	__construct (private Services $http, private \ilCtrlInterface $ctrl)
	ctrl ()
	redirect (string $command, ?string $target_class=null)
	getHereAsFlow ()
	getParentAsURI (?string $cmd=null)
	getHereAsURI (?string $cmd=null)
	getTranslationAsURI (?string $command=null)
	getURI (string $with_path)
	getLinkTarget (object $target_class, ?string $command=null)
	getCurrentClass ()
	getTargetByClass (array|string $target_class, ?string $command=null)
	getTargetURI (object|array|string $target_class, ?string $command=null)
	getCommand (?string $fallback=null)

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 31 of file Flow.php.

Constructor & Destructor Documentation

__construct()

ILIAS\GlobalScreen\GUI\Flow\Flow::__construct	(	private Services	$http,
		private \ilCtrlInterface	$ctrl
	)

Definition at line 33 of file Flow.php.

      {
    }

Member Function Documentation

ctrl()

ILIAS\GlobalScreen\GUI\Flow\Flow::ctrl

(

)

Definition at line 39 of file Flow.php.

                          : \ilCtrlInterface
    {
        return $this->ctrl;
    }

Referenced by ILIAS\GlobalScreen\GUI\Flow\Flow\getCommand(), ILIAS\GlobalScreen\GUI\Flow\Flow\getCurrentClass(), ILIAS\GlobalScreen\GUI\Flow\Flow\getHereAsFlow(), ILIAS\GlobalScreen\GUI\Flow\Flow\getLinkTarget(), ILIAS\GlobalScreen\GUI\Flow\Flow\getParentAsURI(), ILIAS\GlobalScreen\GUI\Flow\Flow\getTargetByClass(), ILIAS\GlobalScreen\GUI\Flow\Flow\getTranslationAsURI(), and ILIAS\GlobalScreen\GUI\Flow\Flow\redirect().

Here is the caller graph for this function:

getCommand()

ILIAS\GlobalScreen\GUI\Flow\Flow::getCommand

(

?string

$fallback = null

)

Definition at line 121 of file Flow.php.

                                                        : string
    {
        $cmd = $this->ctrl->getCmd($fallback);
        return empty($cmd) ? ($fallback ?? '') : $cmd;
    }

References ILIAS\GlobalScreen\GUI\Flow\Flow\ctrl().

Here is the call graph for this function:

getCurrentClass()

ILIAS\GlobalScreen\GUI\Flow\Flow::getCurrentClass

(

)

Definition at line 98 of file Flow.php.

                                     : ?string
    {
        return $this->ctrl->getCmdClass();
    }

References ILIAS\GlobalScreen\GUI\Flow\Flow\ctrl().

Referenced by ILIAS\GlobalScreen\GUI\Flow\Flow\redirect().

Here is the call graph for this function:

Here is the caller graph for this function:

getHereAsFlow()

ILIAS\GlobalScreen\GUI\Flow\Flow::getHereAsFlow

(

)

Definition at line 51 of file Flow.php.

                                   : array
    {
        $call_history = $this->ctrl->getCallHistory();
        return array_map(static fn(array $c): string => $c['cmdClass'], $call_history);
    }

References $c, and ILIAS\GlobalScreen\GUI\Flow\Flow\ctrl().

Referenced by ILIAS\GlobalScreen\GUI\Flow\Flow\getParentAsURI().

Here is the call graph for this function:

Here is the caller graph for this function:

getHereAsURI()

ILIAS\GlobalScreen\GUI\Flow\Flow::getHereAsURI

(

?string

$cmd = null

)

Definition at line 67 of file Flow.php.

                                                     : URI
    {
        $uri = new URI((string) $this->http->request()->getUri());
        if ($cmd !== null) {
            return $uri->withParameter('cmd', $cmd);
        }
        return $uri;
    }

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

getLinkTarget()

ILIAS\GlobalScreen\GUI\Flow\Flow::getLinkTarget	(	object	$target_class,
		?string	$command = null
	)

Deprecated:

use getTargetURI instead

Definition at line 93 of file Flow.php.

                                                                                : string
    {
        return $this->ctrl->getLinkTarget($target_class, $command);
    }

References ILIAS\GlobalScreen\GUI\Flow\Flow\ctrl().

Here is the call graph for this function:

getParentAsURI()

ILIAS\GlobalScreen\GUI\Flow\Flow::getParentAsURI

(

?string

$cmd = null

)

Definition at line 57 of file Flow.php.

                                                       : URI
    {
        $this->ctrl->getCallHistory();
        $command_classes = $this->getHereAsFlow();
        // remove the last class
        array_pop($command_classes);
 
        return $this->getTargetURI($command_classes, $cmd);
    }

References ILIAS\GlobalScreen\GUI\Flow\Flow\ctrl(), ILIAS\GlobalScreen\GUI\Flow\Flow\getHereAsFlow(), and ILIAS\GlobalScreen\GUI\Flow\Flow\getTargetURI().

Here is the call graph for this function:

getTargetByClass()

ILIAS\GlobalScreen\GUI\Flow\Flow::getTargetByClass	(	array|string	$target_class,
		?string	$command = null
	)

Deprecated:

use getTargetURI instead

Definition at line 107 of file Flow.php.

                                                                                         : string
    {
        return $this->ctrl->getLinkTargetByClass($target_class, $command);
    }

References ILIAS\GlobalScreen\GUI\Flow\Flow\ctrl().

Referenced by ILIAS\GlobalScreen\GUI\Flow\Flow\getTargetURI().

Here is the call graph for this function:

Here is the caller graph for this function:

getTargetURI()

ILIAS\GlobalScreen\GUI\Flow\Flow::getTargetURI	(	object|array|string	$target_class,
		?string	$command = null
	)

Definition at line 112 of file Flow.php.

                                                                                            : URI
    {
        if (is_object($target_class)) {
            $target_class = $target_class::class;
        }
 
        return $this->getURI($this->getTargetByClass($target_class, $command));
    }

References ILIAS\GlobalScreen\GUI\Flow\Flow\getTargetByClass(), and ILIAS\GlobalScreen\GUI\Flow\Flow\getURI().

Referenced by ILIAS\GlobalScreen\GUI\Flow\Flow\getParentAsURI(), and ILIAS\GlobalScreen\GUI\Flow\Flow\getTranslationAsURI().

Here is the call graph for this function:

Here is the caller graph for this function:

getTranslationAsURI()

ILIAS\GlobalScreen\GUI\Flow\Flow::getTranslationAsURI

(

?string

$command = null

)

Definition at line 76 of file Flow.php.

                                                                : URI
    {
        $classes = array_map(static fn(array $c): string => $c['cmdClass'], $this->ctrl->getCallHistory());
 
        $classes[] = MultiLanguageGUI::class;
 
        return $this->getTargetURI(MultiLanguageGUI::class, $command);
    }

References $c, ILIAS\GlobalScreen\GUI\Flow\Flow\ctrl(), and ILIAS\GlobalScreen\GUI\Flow\Flow\getTargetURI().

Here is the call graph for this function:

getURI()

ILIAS\GlobalScreen\GUI\Flow\Flow::getURI

(

string

$with_path

)

Definition at line 85 of file Flow.php.

                                             : URI
    {
        return new URI(rtrim(ILIAS_HTTP_PATH, '/') . '/' . ltrim($with_path, '/'));
    }

Referenced by ILIAS\GlobalScreen\GUI\Flow\Flow\getTargetURI().

Here is the caller graph for this function:

redirect()

ILIAS\GlobalScreen\GUI\Flow\Flow::redirect	(	string	$command,
		?string	$target_class = null
	)

Definition at line 44 of file Flow.php.

                                                                           : never
    {
        $target_class ??= $this->getCurrentClass();
 
        $this->ctrl->redirectByClass($target_class, $command);
    }

References ILIAS\GlobalScreen\GUI\Flow\Flow\ctrl(), and ILIAS\GlobalScreen\GUI\Flow\Flow\getCurrentClass().

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• components/ILIAS/GlobalScreen/src/GUI/Flow/Flow.php