ilSoapBackgroundTasksAdministration Class Reference

Inheritance diagram for ilSoapBackgroundTasksAdministration:

Collaboration diagram for ilSoapBackgroundTasksAdministration:

Public Member Functions
	__construct (bool $use_nusoap=true)
	runAsync (string $sid)
Public Member Functions inherited from ilSoapAdministration
	__construct (bool $use_nusoap=true)
	getMessage ()
	appendMessage (string $a_str)
	setMessageCode (string $a_code)
	getMessageCode ()
	reInitUser ()
	isFault ($object)
	getInstallationInfoXML ()
	getClientInfoXML (string $clientid)

Additional Inherited Members
Data Fields inherited from ilSoapAdministration
const	NUSOAP = 1
const	PHP5 = 2
int	$error_method
	Defines type of error handling (PHP5 || NUSOAP) More...
Protected Member Functions inherited from ilSoapAdministration
	checkSession (string $sid)
	explodeSid (string $sid)
	setMessage (string $a_str)
	initAuth (string $sid)
	initIlias ()
	initAuthenticationObject ()
	raiseError (string $a_message, $a_code)
	checkObjectAccess (int $ref_id, array $expected_type, string $permission, bool $returnObject=false)
	check access for ref id: expected type, permission, return object instance if returnobject is true More...
Protected Attributes inherited from ilSoapAdministration
bool	$soap_check = true
string	$message = ''
string	$message_code = ''

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilSoapBackgroundTasksAdministration::__construct

(

bool

$use_nusoap = true

)

Reimplemented from ilSoapAdministration.

Definition at line 27 of file class.ilSoapBackgroundTasksAdministration.php.

    {
        parent::__construct($use_nusoap);
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

runAsync()

ilSoapBackgroundTasksAdministration::runAsync

(

string

$sid

)

Returns

bool|soap_fault|SoapFault|null

Definition at line 35 of file class.ilSoapBackgroundTasksAdministration.php.

    {
        ignore_user_abort(true);
 
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
        global $DIC;
        $tm = new AsyncTaskManager(
            $DIC->backgroundTasks()->persistence()
        );
        $tm->runAsync();
        return true;
    }

References $DIC, ilSoapAdministration\checkSession(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

---

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

• Services/BackgroundTasks/classes/class.ilSoapBackgroundTasksAdministration.php