ilBackgroundTaskJson Class Reference

Background task JSON helper. More...

Collaboration diagram for ilBackgroundTaskJson:

Static Public Member Functions
static	getFailedJson ($a_message)
	Get json for failed task. More...
static	getBlockedJson ($a_task_id)
	Get json for blocked task. More...
static	getProcessingJson ($a_task_id, $a_message, $a_steps)
	Get json for processing task. More...
static	getProgressJson (ilBackgroundTask $a_task, $a_finished_cmd=null, $a_finished_result=null)
	Get json for task progress. More...
static	getFinishedJson ($a_task_id, $a_cmd, $a_result)
	Get json for finished task. More...

Static Protected Member Functions
static	jsonSafeString ($a_text)
	Makes the specified string safe for JSON. More...

Detailed Description

Background task JSON helper.

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 class.ilBackgroundTaskJson.php.

Member Function Documentation

getBlockedJson()

static ilBackgroundTaskJson::getBlockedJson (   $a_task_id )

static

Get json for blocked task.

Parameters

int

$a_task_id

Returns

Definition at line 39 of file class.ilBackgroundTaskJson.php.

References $DIC, and $lng.

Referenced by ilFolderDownloadBackgroundTaskHandler\init().

    {
        global $DIC;
        $lng = $DIC['lng'];
        
        $json = new stdClass();
        
        $json->status = "block";
        $json->task_id = $a_task_id;
        $json->title = self::jsonSafeString($lng->txt("bgtask_blocked"));
        $json->message = self::jsonSafeString($lng->txt("bgtask_blocked_info"));
        $json->button_old = self::jsonSafeString($lng->txt("bgtask_blocked_cancel_old"));
        $json->button_new = self::jsonSafeString($lng->txt("bgtask_blocked_cancel_new"));
        
        return $json;
    }

Here is the caller graph for this function:

getFailedJson()

static ilBackgroundTaskJson::getFailedJson (   $a_message )

static

Get json for failed task.

Parameters

string

$a_message

Returns

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

References $DIC, and $lng.

Referenced by ilFolderDownloadBackgroundTaskHandler\init().

    {
        global $DIC;
        $lng = $DIC['lng'];
        
        $json = new stdClass();
        
        $json->status = "fail";
        $json->title = self::jsonSafeString($lng->txt("bgtask_failure"));
        $json->message = self::jsonSafeString($a_message);
        $json->button = self::jsonSafeString($lng->txt("ok"));
        
        return $json;
    }

Here is the caller graph for this function:

getFinishedJson()

static ilBackgroundTaskJson::getFinishedJson (   $a_task_id,   $a_cmd,   $a_result  )

static

Get json for finished task.

Parameters

int	$a_task_id
string	$a_cmd
string	$a_result

Returns

Definition at line 114 of file class.ilBackgroundTaskJson.php.

Referenced by ilFolderDownloadBackgroundTaskHandler\init().

    {
        $json = new stdClass();
        
        $json->status = "finished";
        $json->task_id = $a_task_id;
        $json->result_cmd = $a_cmd;
        $json->result = $a_result;
        
        return $json;
    }

Here is the caller graph for this function:

getProcessingJson()

static ilBackgroundTaskJson::getProcessingJson (   $a_task_id,   $a_message,   $a_steps  )

static

Get json for processing task.

Parameters

int	$a_task_id
string	$a_message
int	$a_steps

Returns

Definition at line 64 of file class.ilBackgroundTaskJson.php.

References $DIC, and $lng.

Referenced by ilFolderDownloadBackgroundTaskHandler\init().

    {
        global $DIC;
        $lng = $DIC['lng'];
        
        $json = new stdClass();
        
        $json->status = "bg";
        $json->task_id = $a_task_id;
        $json->title = self::jsonSafeString($lng->txt("bgtask_processing"));
        $json->message = self::jsonSafeString($a_message);
        $json->button = self::jsonSafeString($lng->txt("cancel"));
        $json->steps = (int) $a_steps;
        
        return $json;
    }

Here is the caller graph for this function:

getProgressJson()

static ilBackgroundTaskJson::getProgressJson ( ilBackgroundTask  $a_task,   $a_finished_cmd = null,   $a_finished_result = null  )

static

Get json for task progress.

Parameters

ilBackgroundTask	$a_message
string	$a_finished_cmd
string	$a_finished_result

Returns

Definition at line 89 of file class.ilBackgroundTaskJson.php.

References ilBackgroundTask\getCurrentStep(), ilBackgroundTask\getStatus(), and ilBackgroundTask\getSteps().

Referenced by ilBackgroundTaskHub\progress().

    {
        $json = new stdClass();
        
        $json->status = $a_task->getStatus();
        $json->steps = $a_task->getSteps();
        $json->current = $a_task->getCurrentStep();
        
        // if task has been finished, get result action
        if ($a_finished_cmd) {
            $json->result_cmd = $a_finished_cmd;
            $json->result = $a_finished_result;
        }
                
        return $json;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

jsonSafeString()

static ilBackgroundTaskJson::jsonSafeString (   $a_text )

staticprotected

Makes the specified string safe for JSON.

Parameters

string

$a_text

Returns

string

Definition at line 132 of file class.ilBackgroundTaskJson.php.

    {
        if (!is_string($a_text)) {
            return $a_text;
        }

        $a_text = htmlentities($a_text, ENT_COMPAT | ENT_HTML401, "UTF-8");
        $a_text = str_replace("'", "'", $a_text);

        return $a_text;
    }

---

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

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