ilCronStartUp Class Reference

Handles cron (cli) request. More...

Collaboration diagram for ilCronStartUp:

Public Member Functions
	__construct ( $a_client_id, $a_login, $a_password, ilAuthSession $authSession=null)
	authenticate ()
	Start authentication. More...
	logout ()
	Closes the current auth session. More...

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

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,
		ilAuthSession	$authSession = null
	)

Parameters

	$a_client_id
	$a_login
	$a_password
ilAuthSession | null	$authSession

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

      {
        $this->client = $a_client_id;
        $this->username = $a_login;
        $this->password = $a_password;
 
        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';
 
        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.

Returns

bool

Exceptions

ilCronException

if authentication failed.

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

    {
        $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;
                
 
            default:
            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                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

(

)

Closes the current auth session.

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

    {
        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

ilCronStartUp::$authSession

private

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

Referenced by __construct().

$client

ilCronStartUp::$client = ''

private

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

Referenced by __construct().

$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