class.ilOrgUnitPositionDBRepository.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Component\Table;
use ILIAS\Data\Range;
use ILIAS\Data\Order;

class ilOrgUnitPositionDBRepository implements OrgUnitPositionRepository, Table\DataRetrieval
{
    public const TABLE_NAME = 'il_orgu_positions';
    private const TABLE_NAME_UA = 'il_orgu_ua';

    public function __construct(
        protected ilDBInterface $db,
        protected ilOrgUnitAuthorityDBRepository $authorityRepo,
        protected ilOrgUnitUserAssignmentDBRepository $assignmentRepo,
        protected ilLanguage $lng
    ) {
        $this->lng->loadLanguageModule('orgu');
    }

    public function get(int|string $value, string $field): array
    {
        $fields = [
            'id' => 'integer',
            'core_identifier' => 'integer',
            'title' => 'string'
        ];
        if (!in_array($field, array_keys($fields))) {
            throw new Exception("Invalid field: " . $field);
        }

        $query = 'SELECT id, title, description, core_position, core_identifier FROM' . PHP_EOL
            . self::TABLE_NAME
            . ' WHERE ' . self::TABLE_NAME . '.' . $field . ' = ' . $this->db->quote($value, $fields[$field]);
        $res = $this->db->query($query);
        $ret = [];
        while ($rec = $this->db->fetchAssoc($res)) {
            $ret[] = (new ilOrgUnitPosition((int) $rec['id']))
                ->withTitle((string) $rec['title'])
                ->withDescription((string) $rec['description'])
                ->withCorePosition((bool) $rec['core_position'])
                ->withCoreIdentifier((int) $rec['core_identifier'])
                ->withAuthorities($this->authorityRepo->get((int) $rec['id'], ilOrgUnitAuthority::POSITION_ID));
        }

        return $ret;
    }

    public function getSingle(int|string $value, string $field): ?ilOrgUnitPosition
    {
        $pos = $this->get($value, $field);
        if (count($pos) === 0) {
            return null;
        }

        return (array_shift($pos));
    }

    public function getAllPositions(
        ?Range $range = null,
        ?Order $order = null
    ): array {
        $sql_order_part = $order ? $order->join('ORDER BY', fn(...$o) => implode(' ', $o)) : '';
        $sql_range_part = $range ? sprintf('LIMIT %2$s OFFSET %1$s', ...$range->unpack()) : '';

        $query = 'SELECT id, title, description, core_position, core_identifier FROM' . PHP_EOL
            . self::TABLE_NAME . PHP_EOL
            . $sql_order_part . PHP_EOL
            . $sql_range_part;

        $res = $this->db->query($query);
        $ret = [];
        while ($rec = $this->db->fetchAssoc($res)) {
            $ret[] = (new ilOrgUnitPosition((int) $rec['id']))
                ->withTitle((string) $rec['title'])
                ->withDescription((string) $rec['description'])
                ->withCorePosition((bool) $rec['core_position'])
                ->withCoreIdentifier((int) $rec['core_identifier'])
                ->withAuthorities($this->authorityRepo->get((int) $rec['id'], ilOrgUnitAuthority::POSITION_ID));
        }

        return $ret;
    }

    protected function getAllPositionsCount(): int
    {
        $query = 'SELECT id FROM ' . self::TABLE_NAME;
        $res = $this->db->query($query);
        return $this->db->numRows($res);
    }

    public function getArray(?string $key = null, ?string $field = null): array
    {
        if (!in_array($key, ['id', null])) {
            throw new Exception("Invalid key: " . $field);
        }

        $fields = [
            'id' => 'int',
            'title' => 'string',
            'description' => 'string',
            'core_identifier' => 'int',
            'core_position' => 'int'
        ];
        if (!in_array($field, array_keys($fields)) && $field !== null) {
            throw new Exception("Invalid field: " . $field);
        }

        if ($field !== null && $this->db->tableColumnExists(self::TABLE_NAME, $field)) {
            $query = 'SELECT id, ' . $field . ' FROM' . PHP_EOL
                . self::TABLE_NAME
                . '     WHERE 1';

            $res = $this->db->query($query);
            $ret = [];
            while ($rec = $this->db->fetchAssoc($res)) {
                $value = $rec[$field];
                if ($fields[$field] == 'int') {
                    $value = (int) $value;
                } elseif ($fields[$field] == 'string') {
                    $value = (string) $value;
                }
                if ($key !== null) {
                    $ret[$rec[$key]] = $value;
                } else {
                    $ret[] = $value;
                }
            }
        } else {
            $query = 'SELECT id, title, description, core_identifier, core_position FROM' . PHP_EOL
                . self::TABLE_NAME
                . '     WHERE 1';
            $res = $this->db->query($query);
            $ret = [];
            while ($rec = $this->db->fetchAssoc($res)) {
                if ($key !== null) {
                    $ret[$key] = $rec;
                } else {
                    $ret[] = $rec;
                }
            }
        }

        return $ret;
    }

    public function getPositionsForOrgUnit(int $orgu_id): array
    {
        $query = 'SELECT DISTINCT ' . self::TABLE_NAME . '.id, ' . self::TABLE_NAME . '.*' . PHP_EOL
            . 'FROM ' . self::TABLE_NAME . PHP_EOL
            . 'LEFT JOIN ' . self::TABLE_NAME_UA . PHP_EOL
            . 'ON ' . self::TABLE_NAME . '.id = ' . self::TABLE_NAME_UA . '.position_id' . PHP_EOL
            . 'AND ' . self::TABLE_NAME_UA . '.orgu_id = ' . $this->db->quote($orgu_id, 'integer') . PHP_EOL
            . 'WHERE ' . self::TABLE_NAME_UA . '.user_id IS NOT NULL' . PHP_EOL
            . 'OR ' . self::TABLE_NAME . '.core_position = 1';
        $res = $this->db->query($query);
        $ret = [];
        while ($rec = $this->db->fetchAssoc($res)) {
            $ret[] = (new ilOrgUnitPosition((int) $rec['id']))
                ->withTitle((string) $rec['title'])
                ->withDescription((string) $rec['description'])
                ->withCorePosition((bool) $rec['core_position'])
                ->withCoreIdentifier((int) $rec['core_identifier'])
                ->withAuthorities($this->authorityRepo->get((int) $rec['id'], ilOrgUnitAuthority::POSITION_ID));
        }

        return $ret;
    }

    public function create(): ilOrgUnitPosition
    {
        return new ilOrgUnitPosition();
    }

    public function store(ilOrgUnitPosition $position): ilOrgUnitPosition
    {
        if ($position->getId() === 0) {
            $position = $this->insert($position);
        } else {
            $this->update($position);
        }

        $authorities = $position->getAuthorities();
        $ids = [];
        $new_authorities = [];
        foreach ($authorities as $authority) {
            $auth = $this->authorityRepo->store($authority->withPositionId($position->getId()));
            $ids[] = $auth->getId();
            $new_authorities[] = $auth;
        }
        $position = $position->withAuthorities($new_authorities);

        if (count($ids) > 0) {
            $this->authorityRepo->deleteLeftoverAuthorities($ids, $position->getId());
        }
        if (count($ids) === 0) {
            $authorities = $this->authorityRepo->get($position->getId(), 'position_id');
            foreach ($authorities as $authority) {
                $this->authorityRepo->delete($authority->getId());
            }
        }

        return $position;
    }

    private function insert(ilOrgUnitPosition $position): ilOrgUnitPosition
    {
        $id = $this->db->nextId(self::TABLE_NAME);

        $values = [
            'id' => [ 'integer', $id],
            'title' => [ 'text', $position->getTitle() ],
            'description' => [ 'text', $position->getDescription() ],
            'core_position' => [ 'integer', ($position->isCorePosition()) ? 1 : 0 ],
            'core_identifier' => [ 'integer', $position->getCoreIdentifier() ]
        ];

        $this->db->insert(self::TABLE_NAME, $values);

        $ret = (new ilOrgUnitPosition($id))
            ->withTitle($position->getTitle())
            ->withDescription($position->getDescription())
            ->withCorePosition($position->isCorePosition())
            ->withCoreIdentifier($position->getCoreIdentifier())
            ->withAuthorities($position->getAuthorities());

        return $ret;
    }

    private function update(ilOrgUnitPosition $position): void
    {
        $where = [ 'id' => [ 'integer', $position->getId() ] ];

        $values = [
            'title' => [ 'text', $position->getTitle() ],
            'description' => [ 'text', $position->getDescription() ],
            'core_position' => [ 'integer', (($position->isCorePosition()) ? 1 : 0) ],
            'core_identifier' => [ 'integer', $position->getCoreIdentifier() ]
        ];

        $this->db->update(self::TABLE_NAME, $values, $where);
    }

    public function delete(int $position_id): void
    {
        $query = 'DELETE FROM ' . self::TABLE_NAME . PHP_EOL
            . ' WHERE id = ' . $this->db->quote($position_id, 'integer');

        $this->db->manipulate($query);

        $authorities = $this->authorityRepo->get($position_id, 'position_id');
        foreach ($authorities as $authority) {
            $this->authorityRepo->delete($authority->getId());
        }

        $assignments = $this->assignmentRepo->getByPosition($position_id);
        foreach ($assignments as $assignment) {
            $this->assignmentRepo->delete($assignment);
        }
    }

    public function getAuthority(?int $id): ilOrgUnitAuthority
    {
        if ($id === null) {
            return $this->authorityRepo->create();
        } else {
            $authority = $this->authorityRepo->get($id, 'id');
            return array_shift($authority);
        }
    }

    public function getTotalRowCount(
        ?array $filter_data,
        ?array $additional_parameters
    ): ?int {
        return $this->getAllPositionsCount();
    }

    public function getRows(
        Table\DataRowBuilder $row_builder,
        array $visible_column_ids,
        Range $range,
        Order $order,
        ?array $filter_data,
        ?array $additional_parameters
    ): \Generator {
        foreach ($this->getAllPositions($range, $order) as $pos) {
            $row_id = (string) $pos->getId();
            $record = [
                'title' => $pos->getTitle(),
                'description' => $pos->getDescription(),
                'authorities' => implode("<br>", $this->getAuthorityDescription($pos->getAuthorities())),
                'is_core_position' => $pos->isCorePosition(),
            ];

            yield $row_builder->buildDataRow($row_id, $record)
                ->withDisabledAction('delete', $record['is_core_position']);
        }
    }

    private function getAuthorityDescription(array $authorities): array
    {
        $lang_keys = [
            'in',
            'over',
            'scope_' . ilOrgUnitAuthority::SCOPE_SAME_ORGU,
            'scope_' . ilOrgUnitAuthority::SCOPE_SUBSEQUENT_ORGUS,
            'over_' . ilOrgUnitAuthority::OVER_EVERYONE,
        ];
        $t = [];
        foreach ($lang_keys as $key) {
            $t[$key] = $this->lng->txt($key);
        }

        $authority_description = [];
        foreach ($authorities as $authority) {
            switch ($authority->getOver()) {
                case ilOrgUnitAuthority::OVER_EVERYONE:
                    $over_txt = $t["over_" . $authority->getOver()];
                    break;
                default:
                    $over_txt = $this
                        ->getSingle($authority->getOver(), 'id')
                        ->getTitle();
                    break;
            }

            $authority_description[] = implode(" ", [
                $t["over"],
                $over_txt,
                $t["in"],
                $t["scope_" . $authority->getScope()]
            ]);
        }

        return $authority_description;
    }
}