ilCtrlStructureStoredObjective Class Reference

Inheritance diagram for ilCtrlStructureStoredObjective:

Collaboration diagram for ilCtrlStructureStoredObjective:

Public Member Functions
	__construct (\ilCtrlStructureReader $ctrl_reader, bool $populate_before=true)
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)
	@inheritDoc More...

Data Fields
const	TABLE_CLASSFILES = "ctrl_classfile"
const	TABLE_CALLS = "ctrl_calls"

Protected Attributes
	$ctrl_reader
	$populate_before

Detailed Description

Definition at line 6 of file class.ilCtrlStructureStoredObjective.php.

Constructor & Destructor Documentation

__construct()

ilCtrlStructureStoredObjective::__construct	(	\ilCtrlStructureReader	$ctrl_reader,
		bool	$populate_before = true
	)

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

    {
        $this->ctrl_reader = $ctrl_reader;
        $this->populate_before = $populate_before;
    }

References $ctrl_reader, and $populate_before.

Member Function Documentation

achieve()

ilCtrlStructureStoredObjective::achieve

(

Setup\Environment

$environment

)

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

                                                            : Setup\Environment
    {
        $db = $environment->getResource(Setup\Environment::RESOURCE_DATABASE);
        if (!$db) {
            throw new Setup\UnachievableException("Need DB to store control-structure");
        }
 
        if (!defined("ILIAS_ABSOLUTE_PATH")) {
            define("ILIAS_ABSOLUTE_PATH", dirname(__FILE__, 5));
        }
 
        // ATTENTION: This is a total abomination. It only exists to allow various
        // sub components of the various readers to run. This is a memento to the
        // fact, that dependency injection is something we want. Currently, every
        // component could just service locate the whole world via the global $DIC.
        $DIC = $GLOBALS["DIC"];
        $GLOBALS["DIC"] = new DI\Container();
        $GLOBALS["DIC"]["ilDB"] = $db;
 
        $reader = $this->ctrl_reader->withDB($db);
        $reader->executed = false;
        $reader->readStructure(true);
 
        $GLOBALS["DIC"] = $DIC;
 
        return $environment;
    }

References $DIC, $GLOBALS, and ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

getHash()

ilCtrlStructureStoredObjective::getHash

(

)

Definition at line 30 of file class.ilCtrlStructureStoredObjective.php.

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

getLabel()

ilCtrlStructureStoredObjective::getLabel

(

)

Definition at line 38 of file class.ilCtrlStructureStoredObjective.php.

                               : string
    {
        return "ilCtrl-structure is read and stored.";
    }

getPreconditions()

ilCtrlStructureStoredObjective::getPreconditions

(

Setup\Environment

$environment

)

Definition at line 54 of file class.ilCtrlStructureStoredObjective.php.

                                                                     : array
    {
        return [
            new \ilDatabaseInitializedObjective()
        ];
    }

isApplicable()

ilCtrlStructureStoredObjective::isApplicable

(

Setup\Environment

$environment

)

@inheritDoc

Definition at line 95 of file class.ilCtrlStructureStoredObjective.php.

                                                                 : bool
    {
        $db = $environment->getResource(Setup\Environment::RESOURCE_DATABASE);
        if (!$db) {
            throw new Setup\UnachievableException("Need DB to read control-structure");
        }
 
        if (!defined("ILIAS_ABSOLUTE_PATH")) {
            define("ILIAS_ABSOLUTE_PATH", dirname(__FILE__, 5));
        }
 
        $reader = $this->ctrl_reader->withDB($db);
 
        return !$reader->executed;
    }

isNotable()

ilCtrlStructureStoredObjective::isNotable

(

)

Definition at line 46 of file class.ilCtrlStructureStoredObjective.php.

                                : bool
    {
        return true;
    }

Field Documentation

$ctrl_reader

ilCtrlStructureStoredObjective::$ctrl_reader

protected

Definition at line 14 of file class.ilCtrlStructureStoredObjective.php.

Referenced by __construct().

$populate_before

ilCtrlStructureStoredObjective::$populate_before

protected

Definition at line 19 of file class.ilCtrlStructureStoredObjective.php.

Referenced by __construct().

TABLE_CALLS

const ilCtrlStructureStoredObjective::TABLE_CALLS = "ctrl_calls"

Definition at line 9 of file class.ilCtrlStructureStoredObjective.php.

TABLE_CLASSFILES

const ilCtrlStructureStoredObjective::TABLE_CLASSFILES = "ctrl_classfile"

Definition at line 8 of file class.ilCtrlStructureStoredObjective.php.

---

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

• Services/UICore/classes/Setup/class.ilCtrlStructureStoredObjective.php