ilCronStartUp Class Reference

Collaboration diagram for ilCronStartUp:

Public Member Functions
	__construct (string $a_client_id, string $a_login, string $a_password, ?ilAuthSession $authSession=null)
	authenticate ()
	Start authentication. More...
	logout ()

Private Attributes
string	$client
string	$username
string	$password
ilAuthSession	$authSession

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilCronStartUp::__construct	(	string	$a_client_id,
		string	$a_login,
		string	$a_password,
		?ilAuthSession	$authSession = null
	)

@noRector

@noRector

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

      {
        $this->client = $a_client_id;
        $this->username = $a_login;
        $this->password = $a_password;
 
        require_once './Services/Context/classes/class.ilContext.php';
        ilContext::init(ilContext::CONTEXT_CRON);
 
        // @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;
        require_once './include/inc.header.php';
 
        if (null === $authSession) {
            global $DIC;
            $authSession = $DIC['ilAuthSession'];
        }
        $this->authSession = $authSession;
    }

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

Here is the call graph for this function:

Member Function Documentation

authenticate()

ilCronStartUp::authenticate

(

)

Start authentication.

Exceptions

ilCronException

if authentication failed.

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

                                  : bool
    {
        $credentials = new ilAuthFrontendCredentials();
        $credentials->setUsername($this->username);
        $credentials->setPassword($this->password);
 
        $provider_factory = new ilAuthProviderFactory();
        $providers = $provider_factory->getProviders($credentials);
 
        $status = ilAuthStatus::getInstance();
 
        $frontend_factory = new ilAuthFrontendFactory();
        $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_CLI);
 
        $frontend = $frontend_factory->getFrontend(
            $this->authSession,
            $status,
            $credentials,
            $providers
        );
 
        $frontend->authenticate();
 
        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                ilLoggerFactory::getLogger('auth')->debug('Authentication successful; Redirecting to starting page.');
                return true;
 
 
            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
            default:
                throw new ilCronException($status->getTranslatedReason());
        }
 
        return true;
    }

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

Here is the call graph for this function:

logout()

ilCronStartUp::logout

(

)

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

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

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

Here is the call graph for this function:

Field Documentation

$authSession

ilAuthSession ilCronStartUp::$authSession

private

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

Referenced by __construct().

$client

string ilCronStartUp::$client

private

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

Referenced by __construct().

$password

string ilCronStartUp::$password

private

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

$username

string ilCronStartUp::$username

private

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

---

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

• Services/Cron/classes/class.ilCronStartUp.php