ilOrgUnitOperationRegisteredObjective Class Reference

Inheritance diagram for ilOrgUnitOperationRegisteredObjective:

Collaboration diagram for ilOrgUnitOperationRegisteredObjective:

Public Member Functions
	__construct (string $operation_name, string $description, string $context=ilOrgUnitOperationContext::CONTEXT_OBJECT)
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Environment $environment)
	achieve (Environment $environment)
	isApplicable (Environment $environment)

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

Protected Attributes
string	$operation_name
string	$description
string	$context

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilOrgUnitOperationRegisteredObjective::__construct	(	string	$operation_name,
		string	$description,
		string	$context = ilOrgUnitOperationContext::CONTEXT_OBJECT
	)

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

      {
        $this->operation_name = $operation_name;
        $this->description = $description;
        $this->context = $context;
    }

References $context, $description, and $operation_name.

Member Function Documentation

achieve()

ilOrgUnitOperationRegisteredObjective::achieve

(

Environment

$environment

)

Definition at line 63 of file class.ilOrgUnitOperationRegisteredObjective.php.

                                                     : Environment
    {
        $db = $environment->getResource(Environment::RESOURCE_DATABASE);
 
        // abort if context does not exist, just to be safe
        if (!($context_id = $this->getContextId($db, $this->context))) {
            throw new Exception(
                'Context ' . $this->context . ' does not exists,
                 this objective should not be applied!'
            );
        }
 
        // abort if operation already exists in this context, just to be safe
        if ($this->doesOperationExistInContext(
            $db,
            $context_id,
            $this->operation_name
        )) {
            return $environment;
        }
 
        $id = $db->nextId('il_orgu_operations');
        $db->insert('il_orgu_operations', [
            'operation_id' => ['integer', $id],
            'operation_string' => ['text', $this->operation_name],
            'description' => ['text', $this->description],
            'list_order' => ['integer', 0],
            'context_id' => ['integer', $context_id],
        ]);
 
        return $environment;
    }

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

Here is the call graph for this function:

doesOperationExistInContext()

ilOrgUnitOperationRegisteredObjective::doesOperationExistInContext ( ilDBInterface  $db, int  $context_id, string  $operation  )

protected

Definition at line 119 of file class.ilOrgUnitOperationRegisteredObjective.php.

     : bool {
        $result = $db->query('SELECT * FROM il_orgu_operations
            WHERE context_id = ' . $db->quote($context_id, 'integer') .
            ' AND operation_string = ' . $db->quote($operation, 'text'));
        if ($result->numRows()) {
            return true;
        }
        return false;
    }

Referenced by achieve(), and isApplicable().

Here is the caller graph for this function:

getContextId()

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

protected

Defaults to 0 if context is not found.

Definition at line 136 of file class.ilOrgUnitOperationRegisteredObjective.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(), and isApplicable().

Here is the caller graph for this function:

getHash()

ilOrgUnitOperationRegisteredObjective::getHash

(

)

Definition at line 40 of file class.ilOrgUnitOperationRegisteredObjective.php.

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

getLabel()

ilOrgUnitOperationRegisteredObjective::getLabel

(

)

Definition at line 45 of file class.ilOrgUnitOperationRegisteredObjective.php.

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

getPreconditions()

ilOrgUnitOperationRegisteredObjective::getPreconditions

(

Environment

$environment

)

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

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

isApplicable()

ilOrgUnitOperationRegisteredObjective::isApplicable

(

Environment

$environment

)

Definition at line 96 of file class.ilOrgUnitOperationRegisteredObjective.php.

                                                          : bool
    {
        $db = $environment->getResource(Environment::RESOURCE_DATABASE);
 
        // something is wrong if context does not exist
        if (!($context_id = $this->getContextId($db, $this->context))) {
            throw new Setup\UnachievableException(
                'Cannot find context ' . $this->context
            );
        }
 
        // not applicable if operation already exists in this context
        if ($this->doesOperationExistInContext(
            $db,
            $context_id,
            $this->operation_name
        )) {
            return false;
        }
 
        return true;
    }

References doesOperationExistInContext(), getContextId(), and ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

isNotable()

ilOrgUnitOperationRegisteredObjective::isNotable

(

)

Definition at line 51 of file class.ilOrgUnitOperationRegisteredObjective.php.

                               : bool
    {
        return true;
    }

Field Documentation

$context

string ilOrgUnitOperationRegisteredObjective::$context

protected

Definition at line 28 of file class.ilOrgUnitOperationRegisteredObjective.php.

Referenced by __construct().

$description

string ilOrgUnitOperationRegisteredObjective::$description

protected

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

Referenced by __construct().

$operation_name

string ilOrgUnitOperationRegisteredObjective::$operation_name

protected

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

Referenced by __construct().

---

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

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