ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget Class Reference

Inheritance diagram for ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget:

Collaboration diagram for ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget:

Public Member Functions
	__construct (private readonly ilCtrlInterface $ctrl, private readonly ilSetting $settings, private readonly ilAccessHandler $access, private readonly string $http_path=ILIAS_HTTP_PATH,)
	asURI ()
	isValidInternalResource (int $ref_id)
	isInRepository (int $ref_id)
	isAnonymousAccessible (int $ref_id)
	isValidExternalResource (string $url)

Data Fields
const string	INTERNAL_RESSOURCE = 'internal_ressource'
const string	EXTERNAL_RESSOURCE = 'external_ressource'

Detailed Description

Definition at line 32 of file ConfigurableLogoutTarget.php.

Constructor & Destructor Documentation

__construct()

ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget::__construct	(	private readonly ilCtrlInterface	$ctrl,
		private readonly ilSetting	$settings,
		private readonly ilAccessHandler	$access,
		private readonly string	$http_path = ILIAS_HTTP_PATH
	)

Definition at line 37 of file ConfigurableLogoutTarget.php.

      {
    }

Member Function Documentation

asURI()

ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget::asURI

(

)

Implements ILIAS\components\Authentication\Logout\LogoutTarget.

Definition at line 45 of file ConfigurableLogoutTarget.php.

References $ref_id, $url, ilLink\_getStaticLink(), ILIAS\Repository\ctrl(), ILIAS\Repository\int(), ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget\isValidExternalResource(), ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget\isValidInternalResource(), and ILIAS\Repository\settings().

                           : URI
    {
        switch ($this->settings->get('logout_behaviour', '')) {
            case LogoutDestinations::LOGIN_SCREEN->value:
                return LogoutDestinations::LOGIN_SCREEN->asURI($this->ctrl, $this->http_path);

            case self::INTERNAL_RESSOURCE:
                $ref_id = (int) $this->settings->get('logout_behaviour_ref_id', '0');
                if ($this->isValidInternalResource($ref_id)) {
                    return new URI(ilLink::_getStaticLink($ref_id));
                }

                break;

            case self::EXTERNAL_RESSOURCE:
                $url = $this->settings->get('logout_behaviour_url', '');
                if ($url && $this->isValidExternalResource($url)) {
                    return new URI($url);
                }
                break;

            case LogoutDestinations::LOGOUT_SCREEN->value:
            default:
                break;
        }

        return LogoutDestinations::LOGOUT_SCREEN->asURI($this->ctrl, $this->http_path);
    }

Here is the call graph for this function:

isAnonymousAccessible()

ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget::isAnonymousAccessible

(

int

$ref_id

)

Definition at line 84 of file ConfigurableLogoutTarget.php.

References ILIAS\Repository\access(), and ANONYMOUS_USER_ID.

Referenced by ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget\isValidInternalResource().

                                                      : bool
    {
        return $this->access->checkAccessOfUser(ANONYMOUS_USER_ID, 'read', '', $ref_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isInRepository()

ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget::isInRepository

(

int

$ref_id

)

Definition at line 79 of file ConfigurableLogoutTarget.php.

References ilObject\_exists(), and ilObject\_isInTrash().

Referenced by ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget\isValidInternalResource().

                                               : bool
    {
        return ilObject::_exists($ref_id, true) && !ilObject::_isInTrash($ref_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isValidExternalResource()

ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget::isValidExternalResource

(

string

$url

)

Definition at line 89 of file ConfigurableLogoutTarget.php.

Referenced by ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget\asURI().

                                                        : bool
    {
        try {
            $uri = new URI($url);
        } catch (InvalidArgumentException) {
            return false;
        }

        return filter_var($url, FILTER_VALIDATE_URL) !== false;
    }

Here is the caller graph for this function:

isValidInternalResource()

ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget::isValidInternalResource

(

int

$ref_id

)

Definition at line 74 of file ConfigurableLogoutTarget.php.

References ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget\isAnonymousAccessible(), and ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget\isInRepository().

Referenced by ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget\asURI().

                                                        : bool
    {
        return $this->isInRepository($ref_id) && $this->isAnonymousAccessible($ref_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

EXTERNAL_RESSOURCE

const string ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget::EXTERNAL_RESSOURCE = 'external_ressource'

Definition at line 35 of file ConfigurableLogoutTarget.php.

INTERNAL_RESSOURCE

const string ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget::INTERNAL_RESSOURCE = 'internal_ressource'

Definition at line 34 of file ConfigurableLogoutTarget.php.

---

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

• components/ILIAS/Authentication/classes/Logout/ConfigurableLogoutTarget.php