ilBackgroundTasksConfigStoredObjective Class Reference

Inheritance diagram for ilBackgroundTasksConfigStoredObjective:

Collaboration diagram for ilBackgroundTasksConfigStoredObjective:

Public Member Functions
	__construct (\ilBackgroundTasksSetupConfig $config)
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)
	@inheritDoc More...

Protected Attributes
ilBackgroundTasksSetupConfig	$config

Detailed Description

Definition at line 21 of file class.ilBackgroundTasksConfigStoredObjective.php.

Constructor & Destructor Documentation

__construct()

ilBackgroundTasksConfigStoredObjective::__construct

(

\ilBackgroundTasksSetupConfig

$config

)

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

      {
        $this->config = $config;
    }

References $config.

Member Function Documentation

achieve()

ilBackgroundTasksConfigStoredObjective::achieve

(

Setup\Environment

$environment

)

Definition at line 56 of file class.ilBackgroundTasksConfigStoredObjective.php.

                                                           : Setup\Environment
    {
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
 
        if (!$ini->groupExists("background_tasks")) {
            $ini->addGroup("background_tasks");
        }
 
        $ini->setVariable("background_tasks", "concurrency", $this->config->getType());
        $ini->setVariable("background_tasks", "number_of_concurrent_tasks", $this->config->getMaxCurrentTasks());
 
        if (!$ini->write()) {
            throw new Setup\UnachievableException("Could not write ilias.ini.php");
        }
 
        return $environment;
    }

References $ini.

getHash()

ilBackgroundTasksConfigStoredObjective::getHash

(

)

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

                             : string
    {
        return hash("sha256", self::class);
    }

getLabel()

ilBackgroundTasksConfigStoredObjective::getLabel

(

)

Definition at line 36 of file class.ilBackgroundTasksConfigStoredObjective.php.

                              : string
    {
        return "Fill ini with settings for Services/BackgroundTasks";
    }

getPreconditions()

ilBackgroundTasksConfigStoredObjective::getPreconditions

(

Setup\Environment

$environment

)

Returns

\ilIniFilesLoadedObjective[]

Definition at line 49 of file class.ilBackgroundTasksConfigStoredObjective.php.

                                                                    : array
    {
        return [
            new ilIniFilesLoadedObjective()
        ];
    }

isApplicable()

ilBackgroundTasksConfigStoredObjective::isApplicable

(

Setup\Environment

$environment

)

@inheritDoc

Definition at line 77 of file class.ilBackgroundTasksConfigStoredObjective.php.

                                                                : bool
    {
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
 
        return
            !$ini->groupExists("background_tasks") ||
            $ini->readVariable("background_tasks", "concurrency") !== $this->config->getType() ||
            $ini->readVariable("background_tasks", "number_of_concurrent_tasks") !== $this->config->getMaxCurrentTasks()
        ;
    }

References $ini.

isNotable()

ilBackgroundTasksConfigStoredObjective::isNotable

(

)

Definition at line 41 of file class.ilBackgroundTasksConfigStoredObjective.php.

                               : bool
    {
        return false;
    }

Field Documentation

$config

ilBackgroundTasksSetupConfig ilBackgroundTasksConfigStoredObjective::$config

protected

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

Referenced by __construct().

---

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

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