class.ilOrgUnitOperationContextRegisteredObjective.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Setup;
use ILIAS\Setup\Environment;

class ilOrgUnitOperationContextRegisteredObjective implements Setup\Objective
{
    protected string $context_name;
    protected ?string $parent_context;

    public function __construct(
        string $context_name,
        ?string $parent_context = null
    ) {
        $this->context_name = $context_name;
        $this->parent_context = $parent_context;
    }

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

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

    public function isNotable(): bool
    {
        return true;
    }

    public function getPreconditions(Environment $environment): array
    {
        return [
            new ilDatabaseInitializedObjective()
        ];
    }

    public function achieve(Environment $environment): 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;
    }

    public function isApplicable(Environment $environment): 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;
    }

    protected function doesContextExist(
        ilDBInterface $db,
        string $context
    ): bool {
        return (bool) $this->getContextId($db, $context);
    }

    protected function getContextId(
        ilDBInterface $db,
        string $context
    ): 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;
    }
}