ilOrgUnitOperationContextRegisteredObjective Class Reference

Inheritance diagram for ilOrgUnitOperationContextRegisteredObjective:

Collaboration diagram for ilOrgUnitOperationContextRegisteredObjective:

Public Member Functions
	__construct (string $context_name, ?string $parent_context=null)
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Environment $environment)
	achieve (Environment $environment)
	isApplicable (Environment $environment)

Protected Member Functions
	doesContextExist (ilDBInterface $db, string $context)
	getContextId (ilDBInterface $db, string $context)
	Defaults to 0 if context is not found. More...

Protected Attributes
string	$context_name
string	$parent_context

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilOrgUnitOperationContextRegisteredObjective::__construct	(	string	$context_name,
		?string	$parent_context = null
	)

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

      {
        $this->context_name = $context_name;
        $this->parent_context = $parent_context;
    }

References $context_name, and $parent_context.

Member Function Documentation

achieve()

ilOrgUnitOperationContextRegisteredObjective::achieve

(

Environment

$environment

)

Definition at line 60 of file class.ilOrgUnitOperationContextRegisteredObjective.php.

                                                     : Environment
    {
        $db = $environment->getResource(Environment::RESOURCE_DATABASE);
 
        // abort if the context already exists, just to be safe
        if ($this->doesContextExist($db, $this->context_name)) {
            return $environment;
        }
 
        $parent_context_id = 0;
        if (isset($this->parent_context)) {
            // abort if the parent context does not exist, just to be safe
            if (!($id = $this->getContextId($db, $this->parent_context))) {
                throw new Exception(
                    'Parent context ' . $this->context_name . ' does not exist,
                     this objective should not be applied!'
                );
            }
            $parent_context_id = $id;
        }
 
        $id = $db->nextId('il_orgu_op_contexts');
        $db->insert('il_orgu_op_contexts', [
            'id' => ['integer', $id],
            'context' => ['text', $this->context_name],
            'parent_context_id' => ['integer', $parent_context_id]
        ]);
 
        return $environment;
    }

References $id, doesContextExist(), getContextId(), and ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

doesContextExist()

ilOrgUnitOperationContextRegisteredObjective::doesContextExist ( ilDBInterface  $db, string  $context  )

protected

Definition at line 112 of file class.ilOrgUnitOperationContextRegisteredObjective.php.

     : bool {
        return (bool) $this->getContextId($db, $context);
    }

Referenced by achieve(), and isApplicable().

Here is the caller graph for this function:

getContextId()

ilOrgUnitOperationContextRegisteredObjective::getContextId ( ilDBInterface  $db, string  $context  )

protected

Defaults to 0 if context is not found.

Definition at line 122 of file class.ilOrgUnitOperationContextRegisteredObjective.php.

     : int {
        $result = $db->query('SELECT id FROM il_orgu_op_contexts
            WHERE context = ' . $db->quote($context, 'text'));
        if (!($row = $result->fetchObject())) {
            return 0;
        }
        return (int) $row->id;
    }

Referenced by achieve().

Here is the caller graph for this function:

getHash()

ilOrgUnitOperationContextRegisteredObjective::getHash

(

)

Definition at line 37 of file class.ilOrgUnitOperationContextRegisteredObjective.php.

                             : string
    {
        return hash('sha256', self::class . '::' . $this->context_name);
    }

getLabel()

ilOrgUnitOperationContextRegisteredObjective::getLabel

(

)

Definition at line 42 of file class.ilOrgUnitOperationContextRegisteredObjective.php.

                              : string
    {
        return 'Add OrgUnit operation context (name=' . $this->context_name .
            ';parent_context=' . $this->parent_context . ')';
    }

getPreconditions()

ilOrgUnitOperationContextRegisteredObjective::getPreconditions

(

Environment

$environment

)

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

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

isApplicable()

ilOrgUnitOperationContextRegisteredObjective::isApplicable

(

Environment

$environment

)

Definition at line 91 of file class.ilOrgUnitOperationContextRegisteredObjective.php.

                                                          : bool
    {
        $db = $environment->getResource(Environment::RESOURCE_DATABASE);
 
        // not applicable if the context already exists
        if ($this->doesContextExist($db, $this->context_name)) {
            return false;
        }
 
        if (isset($this->parent_context)) {
            // something is wrong if the parent context does not exist
            if (!$this->doesContextExist($db, $this->parent_context)) {
                throw new Exception(
                    'Cannot find parent context ' . $this->parent_context
                );
            }
        }
 
        return true;
    }

References doesContextExist(), and ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

isNotable()

ilOrgUnitOperationContextRegisteredObjective::isNotable

(

)

Definition at line 48 of file class.ilOrgUnitOperationContextRegisteredObjective.php.

                               : bool
    {
        return true;
    }

Field Documentation

$context_name

string ilOrgUnitOperationContextRegisteredObjective::$context_name

protected

Definition at line 26 of file class.ilOrgUnitOperationContextRegisteredObjective.php.

Referenced by __construct().

$parent_context

string ilOrgUnitOperationContextRegisteredObjective::$parent_context

protected

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

Referenced by __construct().

---

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

• components/ILIAS/OrgUnit/classes/Setup/class.ilOrgUnitOperationContextRegisteredObjective.php