ilBackgroundTaskHandler Interface Reference

Background task handler interface. More...

Inheritance diagram for ilBackgroundTaskHandler:

Collaboration diagram for ilBackgroundTaskHandler:

Public Member Functions
	getTask ()
	Get current task instance. More...
	init ($a_params)
	Init background task. More...
	process ()
	Process the task. More...
	cancel ()
	Cancel the task. More...
	finish ()
	Finish the task. More...
	deleteTaskAndFiles ()
	Remove task and its files. More...

Static Public Member Functions
static	getInstanceFromTask (ilBackgroundTask $a_task)
	Constructor/Factory. More...

Detailed Description

Background task handler interface.

Author

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

Definition at line 10 of file interface.ilBackgroundTaskHandler.php.

Member Function Documentation

cancel()

ilBackgroundTaskHandler::cancel

(

)

Cancel the task.

Implemented in ilZipBackgroundTaskHandler.

deleteTaskAndFiles()

ilBackgroundTaskHandler::deleteTaskAndFiles

(

)

Remove task and its files.

Implemented in ilZipBackgroundTaskHandler.

finish()

ilBackgroundTaskHandler::finish

(

)

Finish the task.

Implemented in ilZipBackgroundTaskHandler.

getInstanceFromTask()

static ilBackgroundTaskHandler::getInstanceFromTask ( ilBackgroundTask  $a_task )

static

Constructor/Factory.

Parameters

ilBackgroundTask

$a_task

Returns

\self

Implemented in ilFolderDownloadBackgroundTaskHandler.

getTask()

ilBackgroundTaskHandler::getTask

(

)

Get current task instance.

Returns

\ilBackgroundTask

Implemented in ilZipBackgroundTaskHandler.

init()

ilBackgroundTaskHandler::init

(

$a_params

)

Init background task.

Parameters

mixed

$a_params

Returns

\stdClass json

Implemented in ilFolderDownloadBackgroundTaskHandler.

process()

ilBackgroundTaskHandler::process

(

)

Process the task.

Implemented in ilZipBackgroundTaskHandler.

---

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

• Services/BackgroundTask/interfaces/interface.ilBackgroundTaskHandler.php