ilBackgroundTasksSetupConfig Class Reference

Inheritance diagram for ilBackgroundTasksSetupConfig:

Collaboration diagram for ilBackgroundTasksSetupConfig:

Public Member Functions
	__construct (string $type, int $max_concurrent_tasks)
	getType ()
	getMaxCurrentTasks ()

Data Fields
const	TYPE_SYNCHRONOUS = "sync"
const	TYPE_ASYNCHRONOUS = "async"

Protected Attributes
string	$type
int	$max_concurrent_tasks

Detailed Description

Definition at line 22 of file class.ilBackgroundTasksSetupConfig.php.

Constructor & Destructor Documentation

__construct()

ilBackgroundTasksSetupConfig::__construct	(	string	$type,
		int	$max_concurrent_tasks
	)

Definition at line 31 of file class.ilBackgroundTasksSetupConfig.php.

      {
        $types = [
            self::TYPE_SYNCHRONOUS,
            self::TYPE_ASYNCHRONOUS
        ];
        if (!in_array($type, $types)) {
            throw new \InvalidArgumentException(
                "Unknown background tasks type: '$type'"
            );
        }
        if ($max_concurrent_tasks < 1) {
            throw new \InvalidArgumentException(
                "There must be at least 1 concurrent background task."
            );
        }
        $this->type = $type;
        $this->max_concurrent_tasks = $max_concurrent_tasks;
    }

References $max_concurrent_tasks, $type, TYPE_ASYNCHRONOUS, and TYPE_SYNCHRONOUS.

Member Function Documentation

getMaxCurrentTasks()

ilBackgroundTasksSetupConfig::getMaxCurrentTasks

(

)

Definition at line 58 of file class.ilBackgroundTasksSetupConfig.php.

                                        : int
    {
        return $this->max_concurrent_tasks;
    }

References $max_concurrent_tasks.

getType()

ilBackgroundTasksSetupConfig::getType

(

)

Definition at line 53 of file class.ilBackgroundTasksSetupConfig.php.

                             : string
    {
        return $this->type;
    }

References $type.

Field Documentation

$max_concurrent_tasks

int ilBackgroundTasksSetupConfig::$max_concurrent_tasks

protected

Definition at line 29 of file class.ilBackgroundTasksSetupConfig.php.

Referenced by __construct(), and getMaxCurrentTasks().

$type

string ilBackgroundTasksSetupConfig::$type

protected

Definition at line 27 of file class.ilBackgroundTasksSetupConfig.php.

Referenced by __construct(), and getType().

TYPE_ASYNCHRONOUS

const ilBackgroundTasksSetupConfig::TYPE_ASYNCHRONOUS = "async"

Definition at line 25 of file class.ilBackgroundTasksSetupConfig.php.

Referenced by __construct().

TYPE_SYNCHRONOUS

const ilBackgroundTasksSetupConfig::TYPE_SYNCHRONOUS = "sync"

Definition at line 24 of file class.ilBackgroundTasksSetupConfig.php.

Referenced by __construct(), and ilBackgroundTasksSetupAgent\getArrayToConfigTransformation().

---

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

• Services/BackgroundTasks/classes/Setup/class.ilBackgroundTasksSetupConfig.php