ILIAS\Setup\Activities\GetStatus Class Reference

This is a stub... More...

Inheritance diagram for ILIAS\Setup\Activities\GetStatus:

Collaboration diagram for ILIAS\Setup\Activities\GetStatus:

Public Member Functions
	getDescription ()
	getInputDescription ()
	getOutputDescription (\ILIAS\Data\Description\Factory $f)
	isAllowedToPerform (int $usr_id, mixed $parameters)
	This shall check if the given user is allowed to perform the activity based on business rules of this component. More...
	perform (mixed $parameters)
	This shall perform the activity. More...
	maybePerformAs (int $usr_id, array $raw_parameters)
	Grinds the $raw_parameters through the input description, checks if the users is allowed to perform the action as requested and, if so, then attempts to performs it. More...
Public Member Functions inherited from ILIAS\Component\Activities\Query
	getType ()
Public Member Functions inherited from ILIAS\Component\Activities\ActivityImpl
	getName ()
	Shall return classname of the Activity, wrapped in Name. More...
Public Member Functions inherited from ILIAS\Component\Activities\Activity
	getOutputDescription (Description\Factory $f)

Detailed Description

This is a stub...

Definition at line 31 of file GetStatus.php.

Member Function Documentation

getDescription()

ILIAS\Setup\Activities\GetStatus::getDescription

(

)

Implements ILIAS\Component\Activities\Activity.

Definition at line 33 of file GetStatus.php.

                                    : Text\SimpleDocumentMarkdown
    {
    }

getInputDescription()

ILIAS\Setup\Activities\GetStatus::getInputDescription

(

)

Implements ILIAS\Component\Activities\Activity.

Definition at line 37 of file GetStatus.php.

                                         : \ILIAS\UI\Component\Input\Control\Form\FormInput
    {
    }

getOutputDescription()

ILIAS\Setup\Activities\GetStatus::getOutputDescription

(

\ILIAS\Data\Description\Factory

$f

)

Definition at line 41 of file GetStatus.php.

                                                                            : \ILIAS\Data\Description\Description
    {
    }

isAllowedToPerform()

ILIAS\Setup\Activities\GetStatus::isAllowedToPerform	(	int	$usr_id,
		mixed	$parameters
	)

This shall check if the given user is allowed to perform the activity based on business rules of this component.

This shall, for example, check if the given user may add this other user to a course based on RBAC and position permissions, but this shall not check overall business rules such as: root may do everything. This shall not cause any observable side effects.

Parameters

mixed

$parameters

whatever the FormInput from getInputDescription produces.

Implements ILIAS\Component\Activities\Activity.

Definition at line 45 of file GetStatus.php.

                                                                      : bool
    {
    }

maybePerformAs()

ILIAS\Setup\Activities\GetStatus::maybePerformAs	(	int	$usr_id,
		array	$raw_parameters
	)

Grinds the $raw_parameters through the input description, checks if the users is allowed to perform the action as requested and, if so, then attempts to performs it.

Wraps the result and possible errors in the Result type.

Implements ILIAS\Component\Activities\Activity.

Definition at line 53 of file GetStatus.php.

                                                                      : Result
    {
    }

perform()

ILIAS\Setup\Activities\GetStatus::perform

(

mixed

$parameters

)

This shall perform the activity.

This shall not check if a user is allowed to perform the activity. The returned data should match the Description given by getOutputDescription.

Exceptions

any	SPL Exception (https://www.php.net/manual/en/spl.exceptions.php)

Parameters

mixed

$parameters

whatever the FormInput from getInputDescription produces.

Implements ILIAS\Component\Activities\Activity.

Definition at line 49 of file GetStatus.php.

                                              : mixed
    {
    }

---

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

• components/ILIAS/Setup/src/Activities/GetStatus.php