ilCronStartUp Class Reference

Collaboration diagram for ilCronStartUp:

Public Member Functions
	__construct (private readonly string $client, private readonly string $username, ?ilAuthSession $authSession=null)
	authenticate ()
	logout ()

Private Attributes
readonly ilAuthSession	$authSession
bool	$authenticated = false

Detailed Description

Definition at line 21 of file class.ilCronStartUp.php.

Constructor & Destructor Documentation

__construct()

ilCronStartUp::__construct	(	private readonly string	$client,
		private readonly string	$username,
		?ilAuthSession	$authSession = null
	)

Definition at line 26 of file class.ilCronStartUp.php.

References $_GET, $authSession, $client, $DIC, ilContext\CONTEXT_CRON, ilContext\init(), and ilInitialisation\initILIAS().

      {
        ilContext::init(ilContext::CONTEXT_CRON);

        // TODO @see mantis 20371: To get rid of this, the authentication service has to provide a mechanism to pass the client_id
        $_GET['client_id'] = $this->client;
        ilInitialisation::initILIAS();

        if (null === $authSession) {
            global $DIC;
            $authSession = $DIC['ilAuthSession'];
        }
        $this->authSession = $authSession;
    }

Here is the call graph for this function:

Member Function Documentation

authenticate()

ilCronStartUp::authenticate

(

)

Exceptions

ilCronException

if authentication failed.

Definition at line 49 of file class.ilCronStartUp.php.

References ilAuthFrontendFactory\CONTEXT_CLI, ilAuthStatus\getInstance(), ilLoggerFactory\getLogger(), ilAuthStatus\STATUS_AUTHENTICATED, and ilAuthStatus\STATUS_AUTHENTICATION_FAILED.

                                  : bool
    {
        $credentials = new ilAuthFrontendCredentials();
        $credentials->setUsername($this->username);

        $status = ilAuthStatus::getInstance();

        $frontend_factory = new ilAuthFrontendFactory();
        $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_CLI);

        $provider_factory = new ilAuthProviderCliFactory();

        $frontend = $frontend_factory->getFrontend(
            $this->authSession,
            $status,
            $credentials,
            $provider_factory->getProviders($credentials)
        );

        $frontend->authenticate();

        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                $this->authenticated = true;
                ilLoggerFactory::getLogger('auth')->debug('Authentication successful; Redirecting to starting page.');
                return true;

            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
            default:
                throw new ilCronException($status->getTranslatedReason());
        }
    }

Here is the call graph for this function:

logout()

ilCronStartUp::logout

(

)

Definition at line 82 of file class.ilCronStartUp.php.

References ilSession\SESSION_CLOSE_USER, and ilSession\setClosingContext().

                            : void
    {
        if ($this->authenticated) {
            ilSession::setClosingContext(ilSession::SESSION_CLOSE_USER);
            $this->authSession->logout();
        }
    }

Here is the call graph for this function:

Field Documentation

$authenticated

bool ilCronStartUp::$authenticated = false

private

Definition at line 24 of file class.ilCronStartUp.php.

$authSession

readonly ilAuthSession ilCronStartUp::$authSession

private

Definition at line 23 of file class.ilCronStartUp.php.

Referenced by __construct().

---

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

• components/ILIAS/Cron/classes/class.ilCronStartUp.php