ILIAS\File\Sanitation\SanitationReportJob Class Reference

Class SanitationReportJob. More...

Inheritance diagram for ILIAS\File\Sanitation\SanitationReportJob:

Collaboration diagram for ILIAS\File\Sanitation\SanitationReportJob:

Public Member Functions
	run (array $input, Observer $observer)
	isStateless ()
	getExpectedTimeOfTaskInSeconds ()
	getInputTypes ()
	getOutputType ()
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractJob
	getInput ()
	Returns Value[] More...
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	setInput (array $values)
	getOutput ()
	getInput ()
	getType ()
	unfoldTask ()
	Unfold the task. More...
	getRemoveOption ()
	Returns Option An Option to remove the current task and do some cleanup if possible. This Option is displayed if the Bucket is completed. You do not have to provide an additional Option to remove in your UserInteraction, the remove-Option is added to the list of Options (last position) See also self::getAbortOption(); More...
	getAbortOption ()
	Returns Option In case a Job is failed or did not respond for some time, an Abort-Option is displayed. There is already a Standard-Abort-Option registered, you can override with your own and do some cleanup if possible. More...
	getType ()
	getInputTypes ()
	getOutputType ()
	getOutput ()
	setInput (array $values)
	getInput ()
	unfoldTask ()
	getRemoveOption ()
	getAbortOption ()
	run (array $input, Observer $observer)
	isStateless ()
	getInput ()
	getExpectedTimeOfTaskInSeconds ()

Additional Inherited Members
Data Fields inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
const	MAIN_REMOVE = 'bt_main_remove'
const	MAIN_ABORT = 'bt_main_abort'
Protected Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	checkTypes ($values)
	extractType ($value)
Protected Attributes inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	$input = []
	$output

Detailed Description

Class SanitationReportJob.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 17 of file SanitationReportJob.php.

Member Function Documentation

getExpectedTimeOfTaskInSeconds()

ILIAS\File\Sanitation\SanitationReportJob::getExpectedTimeOfTaskInSeconds

(

)

Returns

int the amount of seconds this task usually taskes. If your task-duration scales with the the amount of data, try to set a possible high value of try to calculate it. If a task duration exceeds this value, it will be displayed as "possibly failed" to the user

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 49 of file SanitationReportJob.php.

    {
        return 3600;
    }

getInputTypes()

ILIAS\File\Sanitation\SanitationReportJob::getInputTypes

(

)

Returns

Type[] A list of types that are taken as input.

Implements ILIAS\BackgroundTasks\Task.

Definition at line 55 of file SanitationReportJob.php.

    {
        return array();
    }

getOutputType()

ILIAS\File\Sanitation\SanitationReportJob::getOutputType

(

)

Returns

Type A single type.

Implements ILIAS\BackgroundTasks\Task.

Definition at line 61 of file SanitationReportJob.php.

    {
        return new ListType(IntegerValue::class);
    }

isStateless()

ILIAS\File\Sanitation\SanitationReportJob::isStateless

(

)

Returns

bool returns true iff the job's output ONLY depends on the input. Stateless task results may be cached!

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 43 of file SanitationReportJob.php.

    {
        return false;
    }

run()

ILIAS\File\Sanitation\SanitationReportJob::run	(	array	$input,
		Observer	$observer
	)

Parameters

\ILIAS\BackgroundTasks\Value[]	$input	This will be a list of Values hinted by getInputTypes.
Observer	$observer	Notify the bucket about your progress!

Returns

Value The returned Value must be of the type hinted by getOutputType.

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 19 of file SanitationReportJob.php.

    {
        global $DIC;
 
        $q = "SELECT * FROM object_data WHERE type='file'";
        $s = $DIC->database()->query($q);
 
        $files_ids = [];
 
        while ($data = $DIC->database()->fetchObject($s)) {
            $file_object = new ilObjFile($data->obj_id, false);
            $san = new FilePathSanitizer($file_object);
            if ($san->needsSanitation()) {
                $files_ids[] = (int) $data->obj_id;
            }
        }
 
        $list = new ListValue();
        $list->setValue($files_ids);
 
        return $list;
    }

References $data, and $DIC.

---

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

• Modules/File/classes/Sanitation/SanitationReportJob.php