ilBackgroundTaskHub Class Reference

background task hub (aka ajax handler, GUI) More...

Collaboration diagram for ilBackgroundTaskHub:

Public Member Functions
	__construct ()
	Constructor. More...
	executeCommand ()
	Execute current command. More...
	isSOAPEnabled ()
	Is soap enabled? More...

Protected Member Functions
	sendJson (stdClass $a_json)
	Send Json to client. More...
	validate ()
	Validate given task. More...
	unblock ()
	Cancel all other tasks, start current one. More...
	process ()
	Process current task. More...
	progress ()
	Check progress of current task. More...
	cancel ()
	Cancel current task. More...
	deliver ()
	Deliver result. More...

Protected Attributes
	$task
	$handler

Detailed Description

background task hub (aka ajax handler, GUI)

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

ilBackgroundTaskHub:

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

Constructor & Destructor Documentation

__construct()

ilBackgroundTaskHub::__construct

(

)

Constructor.

Returns

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

References $DIC, and $lng.

    {
        global $DIC;
        $lng = $DIC['lng'];
        
        $lng->loadLanguageModule("bgtask");
        
        if ((int) $_REQUEST["tid"]) {
            $this->task = new ilBackgroundTask((int) $_REQUEST["tid"]);
            $this->handler = $this->task->getHandlerInstance();
        }
    }

Member Function Documentation

cancel()

ilBackgroundTaskHub::cancel ( )

protected

Cancel current task.

Definition at line 175 of file class.ilBackgroundTaskHub.php.

References ilBackgroundTask\STATUS_CANCELLING.

    {
        // just emit cancelling status, (background) process will stop ASAP
        $this->task->setStatus(ilBackgroundTask::STATUS_CANCELLING);
        $this->task->save();
    }

deliver()

ilBackgroundTaskHub::deliver ( )

protected

Deliver result.

Definition at line 185 of file class.ilBackgroundTaskHub.php.

    {
        // :TODO: delete task?
        
        $this->handler->deliver();
    }

executeCommand()

ilBackgroundTaskHub::executeCommand

(

)

Execute current command.

Definition at line 44 of file class.ilBackgroundTaskHub.php.

References $DIC, $ilCtrl, and exit.

    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        
        $next_class = $ilCtrl->getNextClass($this);
        $cmd = $ilCtrl->getCmd("validate");
            
        switch ($next_class) {
            default:
                if ($cmd == "deliver" ||
                    $ilCtrl->isAsynch()) {
                    $this->$cmd();
                    break;
                }
        }
        
        // deliver file and ajax require exit
        exit();
    }

isSOAPEnabled()

ilBackgroundTaskHub::isSOAPEnabled

(

)

Is soap enabled?

Returns

bool

Definition at line 143 of file class.ilBackgroundTaskHub.php.

References $DIC, $ilSetting, ilContext\CONTEXT_CRON, and ilContext\getType().

Referenced by process().

    {
        global $DIC;
        $ilSetting = $DIC['ilSetting'];

        // see ilMail
        return (extension_loaded('curl') &&
            $ilSetting->get('soap_user_administration') &&
            ilContext::getType() != ilContext::CONTEXT_CRON);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

process()

ilBackgroundTaskHub::process ( )

protected

Process current task.

Definition at line 118 of file class.ilBackgroundTaskHub.php.

References $_COOKIE, array, isSOAPEnabled(), and ilBackgroundTask\STATUS_PROCESSING.

    {
        $this->task->setStatus(ilBackgroundTask::STATUS_PROCESSING);
        $this->task->save();
        
        if (!$this->isSOAPEnabled()) {
            $this->handler->process();
        } else {
            require_once 'Services/WebServices/SOAP/classes/class.ilSoapClient.php';
            $soap_client = new ilSoapClient();
            $soap_client->setResponseTimeout(1);
            $soap_client->enableWSDL(true);
            $soap_client->init();
            $soap_client->call('processBackgroundTask', array(
                session_id() . '::' . $_COOKIE['ilClientId'],
                $this->task->getId()
            ));
        }
    }

Here is the call graph for this function:

progress()

ilBackgroundTaskHub::progress ( )

protected

Check progress of current task.

Definition at line 157 of file class.ilBackgroundTaskHub.php.

References $result, ilBackgroundTaskJson\getProgressJson(), sendJson(), and ilBackgroundTask\STATUS_FINISHED.

    {
        include_once "Services/BackgroundTask/classes/class.ilBackgroundTaskJson.php";
        
        // if task has been finished, get result action
        if ($this->task->getStatus() == ilBackgroundTask::STATUS_FINISHED) {
            $result = $this->handler->finish();
            $json = ilBackgroundTaskJson::getProgressJson($this->task, $result[0], $result[1]);
        } else {
            $json = ilBackgroundTaskJson::getProgressJson($this->task);
        }
        
        $this->sendJson($json);
    }

Here is the call graph for this function:

sendJson()

ilBackgroundTaskHub::sendJson ( stdClass  $a_json )

protected

Send Json to client.

Parameters

stdClass

$a_json

Definition at line 70 of file class.ilBackgroundTaskHub.php.

Referenced by progress(), unblock(), and validate().

    {
        echo json_encode($a_json);
    }

Here is the caller graph for this function:

unblock()

ilBackgroundTaskHub::unblock ( )

protected

Cancel all other tasks, start current one.

Definition at line 95 of file class.ilBackgroundTaskHub.php.

References $DIC, $ilUser, $task, ilBackgroundTask\getActiveByUserId(), sendJson(), and ilBackgroundTask\STATUS_CANCELLING.

    {
        global $DIC;
        $ilUser = $DIC['ilUser'];
        
        foreach (ilBackgroundTask::getActiveByUserId($ilUser->getId()) as $task_id) {
            // leave current task alone
            if ($task_id != $this->task->getId()) {
                // emit cancelling status, running processes will cancel
                $task = new ilBackgroundTask($task_id);
                $task->setStatus(ilBackgroundTask::STATUS_CANCELLING);
                $task->save();
            }
        }
        
        // init/start current task
        $json = $this->handler->init();
        $this->sendJson($json);
    }

Here is the call graph for this function:

validate()

ilBackgroundTaskHub::validate ( )

protected

Validate given task.

Definition at line 78 of file class.ilBackgroundTaskHub.php.

References $_GET, $file, $handler, and sendJson().

    {
        $class = trim($_GET["hid"]);
        $file = "Services/BackgroundTask/classes/class." . $class . ".php";
        if (file_exists($file)) {
            include_once $file;
            $handler = new $class();
            $json = $handler->init($_GET["par"]);
        
            $this->sendJson($json);
        }
    }

Here is the call graph for this function:

Field Documentation

$handler

ilBackgroundTaskHub::$handler

protected

Definition at line 16 of file class.ilBackgroundTaskHub.php.

Referenced by validate().

$task

ilBackgroundTaskHub::$task

protected

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

Referenced by unblock().

---

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

• Services/BackgroundTask/classes/class.ilBackgroundTaskHub.php