ILIAS\Cron\CLI\StartUp Class Reference

Collaboration diagram for ILIAS\Cron\CLI\StartUp:

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

Private Attributes
readonly ilAuthSession	$auth_session
bool	$is_authenticated = false

Detailed Description

Definition at line 25 of file StartUp.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Cron\CLI\StartUp::__construct	(	private readonly string	$client,
		private readonly string	$username,
		?\ilAuthSession	$authSession = null
	)

@noRector

Definition at line 30 of file StartUp.php.

      {
        \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 ($authSession === null) {
            global $DIC;
            $authSession = $DIC['ilAuthSession'];
        }
        $this->auth_session = $authSession;
    }

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

Here is the call graph for this function:

Member Function Documentation

authenticate()

ILIAS\Cron\CLI\StartUp::authenticate

(

)

Definition at line 49 of file StartUp.php.

                                  : 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->auth_session,
            $status,
            $credentials,
            $provider_factory->getProviders($credentials)
        );
 
        $frontend->authenticate();
 
        switch ($status->getStatus()) {
            case \ilAuthStatus::STATUS_AUTHENTICATED:
                $this->is_authenticated = true;
                \ilLoggerFactory::getLogger('auth')->debug('Authentication successful; Redirecting to starting page.');
                return true;
 
            case \ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
            default:
                throw new CronException($status->getTranslatedReason());
        }
    }

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

Here is the call graph for this function:

logout()

ILIAS\Cron\CLI\StartUp::logout

(

)

Definition at line 82 of file StartUp.php.

                            : void
    {
        if ($this->is_authenticated) {
            \ilSession::setClosingContext(\ilSession::SESSION_CLOSE_USER);
            $this->auth_session->logout();
        }
    }

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

Here is the call graph for this function:

Field Documentation

$auth_session

readonly ilAuthSession ILIAS\Cron\CLI\StartUp::$auth_session

private

Definition at line 27 of file StartUp.php.

$is_authenticated

bool ILIAS\Cron\CLI\StartUp::$is_authenticated = false

private

Definition at line 28 of file StartUp.php.

---

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

• components/ILIAS/Cron/src/CLI/StartUp.php