ilSoapBackgroundTaskAdministration Class Reference

Inheritance diagram for ilSoapBackgroundTaskAdministration:

Collaboration diagram for ilSoapBackgroundTaskAdministration:

Public Member Functions
	processBackgroundTask ($a_sid, $a_task_id)
	Process task. More...
Public Member Functions inherited from ilSoapAdministration
	__construct ($use_nusoap=true)
	Constructor. More...
	initErrorWriter ()
	Overwrite error handler. More...
	__explodeSid ($sid)
	__setMessage ($a_str)
	__getMessage ()
	__appendMessage ($a_str)
	__setMessageCode ($a_code)
	__getMessageCode ()
	initAuth ($sid)
	Init authentication. More...
	initIlias ()
	__initAuthenticationObject ($a_auth_mode=AUTH_LOCAL)
	__raiseError ($a_message, $a_code)
	getNIC ($sid)
	get client information from current as xml result set More...
	isFault ($object)
	checkObjectAccess ($ref_id, $expected_type, $permission, $returnObject=false)
	check access for ref id: expected type, permission, return object instance if returnobject is true More...
	getInstallationInfoXML ()
	getClientInfoXML ($clientid)

Additional Inherited Members
Static Public Member Functions inherited from ilSoapAdministration
static	return_bytes ($val)
	calculate bytes from K,M,G modifiers e.g: 8M = 8 * 1024 * 1024 bytes More...
Data Fields inherited from ilSoapAdministration
	$sauth = null
	$error_method = null
Protected Attributes inherited from ilSoapAdministration
	$soap_check = true

Detailed Description

Definition at line 33 of file class.ilSoapBackgroundTaskAdministration.php.

Member Function Documentation

processBackgroundTask()

ilSoapBackgroundTaskAdministration::processBackgroundTask	(		$a_sid,
			$a_task_id
	)

Process task.

Parameters

int

$a_task_id

Returns

boolean

Definition at line 41 of file class.ilSoapBackgroundTaskAdministration.php.

References $handler, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

    {
        $this->initAuth($a_sid);
        $this->initIlias();

        if (!$this->__checkSession($a_sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        
        include_once "Services/BackgroundTask/classes/class.ilBackgroundTask.php";
        $task = new ilBackgroundTask($a_task_id);
        if ($task->exists()) {
            $handler = $task->getHandlerInstance();
            $handler->process();

            return true;
        }
    
        return false;
    }

Here is the call graph for this function:

---

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

• webservice/soap/classes/class.ilSoapBackgroundTaskAdministration.php