ilCronStartUp Class Reference

Handles cron (cli) request. More...

Collaboration diagram for ilCronStartUp:

Public Member Functions
	__construct ($a_client_id, $a_login, $a_password)
	Constructor. More...
	initIlias ()
	Init ILIAS. More...
	authenticate ()
	Start authentication. More...
	logout ()
	Closes the current auth session. More...

Private Attributes
	$client = ''
	$username = ''
	$password = ''

Detailed Description

Handles cron (cli) request.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

__construct()

ilCronStartUp::__construct	(		$a_client_id,
			$a_login,
			$a_password
	)

Constructor.

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

    {
        $this->client = $a_client_id;
        $this->username = $a_login;
        $this->password = $a_password;
    }

Member Function Documentation

authenticate()

ilCronStartUp::authenticate

(

)

Start authentication.

Returns

bool

Exceptions

ilCronException

if authentication failed.

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

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

    {
        include_once './Services/Authentication/classes/Frontend/class.ilAuthFrontendCredentials.php';
        $credentials = new ilAuthFrontendCredentials();
        $credentials->setUsername($this->username);
        $credentials->setPassword($this->password);
        
        include_once './Services/Authentication/classes/Provider/class.ilAuthProviderFactory.php';
        $provider_factory = new ilAuthProviderFactory();
        $providers = $provider_factory->getProviders($credentials);
            
        include_once './Services/Authentication/classes/class.ilAuthStatus.php';
        $status = ilAuthStatus::getInstance();
            
        include_once './Services/Authentication/classes/Frontend/class.ilAuthFrontendFactory.php';
        $frontend_factory = new ilAuthFrontendFactory();
        $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_CLI);
        $frontend = $frontend_factory->getFrontend(
            $GLOBALS['DIC']['ilAuthSession'],
            $status,
            $credentials,
            $providers
        );
            
        $frontend->authenticate();
            
        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                ilLoggerFactory::getLogger('auth')->debug('Authentication successful; Redirecting to starting page.');
                return true;
                

            default:
            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                include_once './Services/Cron/exceptions/class.ilCronException.php';
                throw new ilCronException($status->getTranslatedReason());
        }
        return true;
    }

Here is the call graph for this function:

initIlias()

ilCronStartUp::initIlias

(

)

Init ILIAS.

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

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

    {
        include_once './Services/Context/classes/class.ilContext.php';
        ilContext::init(ilContext::CONTEXT_CRON);
        
        // define client
        // @see mantis 20371
        $_GET['client_id'] = $this->client;
        
        include_once './include/inc.header.php';
    }

Here is the call graph for this function:

logout()

ilCronStartUp::logout

(

)

Closes the current auth session.

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

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

    {
        ilSession::setClosingContext(ilSession::SESSION_CLOSE_USER);
        if (isset($GLOBALS['DIC']['ilAuthSession'])) {
            $GLOBALS['DIC']['ilAuthSession']->logout();
        }
    }

Here is the call graph for this function:

Field Documentation

$client

ilCronStartUp::$client = ''

private

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

Referenced by initIlias().

$password

ilCronStartUp::$password = ''

private

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

$username

ilCronStartUp::$username = ''

private

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

---

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

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