Inheritance diagram for ilOrgUnitPositionDBRepository:

Collaboration diagram for ilOrgUnitPositionDBRepository:

Public Member Functions
	__construct (protected ilDBInterface $db, protected ilOrgUnitAuthorityDBRepository $authorityRepo, protected ilOrgUnitUserAssignmentDBRepository $assignmentRepo, protected ilLanguage $lng)

	get (int\|string $value, string $field)
	Get one or more positions filtered by field/value. More...

	getSingle (int\|string $value, string $field)
	Get a single position from a filtered query (see get()) More...

	getAllPositions (?Range $range=null, ?Order $order=null)
	Returns all position objects. More...

	getArray (?string $key=null, ?string $field=null)
	Returns position data as an array, e.g. More...

	getPositionsForOrgUnit (int $orgu_id)
	Returns all core positions plus all positions with user assignments for a certain org unit (kept for compatibility, filtering by ua will be moved to orgu later) More...

	create ()

	store (ilOrgUnitPosition $position)
	Saves position and its authorities. More...

	delete (int $position_id)
	Deletes position and authorities/user assignments attached to it. More...

	getAuthority (?int $id)
	Gets or creates an authority object, as the authority repo is encapsulated into this repo. More...

	getTotalRowCount (?array $filter_data, ?array $additional_parameters)

	getRows (Table\DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, ?array $filter_data, ?array $additional_parameters)

Public Member Functions inherited from OrgUnitPositionRepository
	get (int\|string $value, string $field)

	getSingle (int\|string $value, string $field)

	getAllPositions ()

	getArray (?string $key, ?string $field)

	getPositionsForOrgUnit (int $orgu_id)

	store (ilOrgUnitPosition $position)

	create ()

	delete (int $position_id)

	getAuthority (?int $id)

Data Fields
const	TABLE_NAME = 'il_orgu_positions'

Protected Member Functions
	getAllPositionsCount ()

Private Member Functions
	insert (ilOrgUnitPosition $position)

	update (ilOrgUnitPosition $position)

	getAuthorityDescription (array $authorities)

Private Attributes
const	TABLE_NAME_UA = 'il_orgu_ua'

Detailed Description

Definition at line 25 of file class.ilOrgUnitPositionDBRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ilOrgUnitPositionDBRepository::__construct	(	protected ilDBInterface	$db,
		protected ilOrgUnitAuthorityDBRepository	$authorityRepo,
		protected ilOrgUnitUserAssignmentDBRepository	$assignmentRepo,
		protected ilLanguage	$lng
	)

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

      {
        $this->lng->loadLanguageModule('orgu');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ create()

ilOrgUnitPositionDBRepository::create ( )

Implements OrgUnitPositionRepository.

Definition at line 213 of file class.ilOrgUnitPositionDBRepository.php.

                            : ilOrgUnitPosition
    {
        return new ilOrgUnitPosition();
    }

◆ delete()

ilOrgUnitPositionDBRepository::delete ( int $position_id )

Deletes position and authorities/user assignments attached to it.

Implements OrgUnitPositionRepository.

Definition at line 293 of file class.ilOrgUnitPositionDBRepository.php.

                                            : 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);
        }
    }

◆ get()

ilOrgUnitPositionDBRepository::get	(	int\|string	$value,
		string	$field
	)

Get one or more positions filtered by field/value.

Returns: ilOrgUnitPosition[]

Exceptions

Exception

Implements OrgUnitPositionRepository.

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

                                                         : 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;
    }

References $res, ilOrgUnitAuthority\POSITION_ID, and ILIAS\GlobalScreen\Scope\Footer\Factory\withTitle().

Here is the call graph for this function:

◆ getAllPositions()

ilOrgUnitPositionDBRepository::getAllPositions	(	?Range	$range = `null`,
		?Order	$order = `null`
	)

Returns all position objects.

Returns: ilOrgUnitPosition[]

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

     : 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;
    }

References ilOrgUnitAuthority\POSITION_ID, and ILIAS\GlobalScreen\Scope\Footer\Factory\withTitle().

Here is the call graph for this function:

◆ getAllPositionsCount()

ilOrgUnitPositionDBRepository::getAllPositionsCount ( )

protected

Definition at line 117 of file class.ilOrgUnitPositionDBRepository.php.

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

References $res.

◆ getArray()

ilOrgUnitPositionDBRepository::getArray	(	?string	$key = `null`,
		?string	$field = `null`
	)

Returns position data as an array, e.g.

for using ids in forms

Exceptions

Exception

Implements OrgUnitPositionRepository.

Definition at line 129 of file class.ilOrgUnitPositionDBRepository.php.

                                                                        : 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;
    }

References $res, and ILIAS\Repository\int().

Here is the call graph for this function:

◆ getAuthority()

ilOrgUnitPositionDBRepository::getAuthority ( ?int $id )

Gets or creates an authority object, as the authority repo is encapsulated into this repo.

Implements OrgUnitPositionRepository.

Definition at line 314 of file class.ilOrgUnitPositionDBRepository.php.

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

References $id.

◆ getAuthorityDescription()

ilOrgUnitPositionDBRepository::getAuthorityDescription ( array $authorities )

private

Definition at line 353 of file class.ilOrgUnitPositionDBRepository.php.

                                                                : 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;
    }

References ILIAS\Repository\lng(), ilOrgUnitAuthority\OVER_EVERYONE, ilOrgUnitAuthority\SCOPE_SAME_ORGU, and ilOrgUnitAuthority\SCOPE_SUBSEQUENT_ORGUS.

Here is the call graph for this function:

◆ getPositionsForOrgUnit()

ilOrgUnitPositionDBRepository::getPositionsForOrgUnit ( int $orgu_id )

Returns all core positions plus all positions with user assignments for a certain org unit (kept for compatibility, filtering by ua will be moved to orgu later)

Returns: ilOrgUnitPosition[]

Implements OrgUnitPositionRepository.

Definition at line 190 of file class.ilOrgUnitPositionDBRepository.php.

                                                        : 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;
    }

References $res, ilOrgUnitAuthority\POSITION_ID, and ILIAS\GlobalScreen\Scope\Footer\Factory\withTitle().

Here is the call graph for this function:

◆ getRows()

ilOrgUnitPositionDBRepository::getRows	(	Table\DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		?array	$filter_data,
		?array	$additional_parameters
	)

Definition at line 331 of file class.ilOrgUnitPositionDBRepository.php.

     : \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']);
        }
    }

◆ getSingle()

ilOrgUnitPositionDBRepository::getSingle	(	int\|string	$value,
		string	$field
	)

Get a single position from a filtered query (see get())

Implements OrgUnitPositionRepository.

Definition at line 76 of file class.ilOrgUnitPositionDBRepository.php.

                                                               : ?ilOrgUnitPosition
    {
        $pos = $this->get($value, $field);
        if (count($pos) === 0) {
            return null;
        }
 
        return (array_shift($pos));
    }

◆ getTotalRowCount()

ilOrgUnitPositionDBRepository::getTotalRowCount	(	?array	$filter_data,
		?array	$additional_parameters
	)

Definition at line 324 of file class.ilOrgUnitPositionDBRepository.php.

     : ?int {
        return $this->getAllPositionsCount();
    }

◆ insert()

ilOrgUnitPositionDBRepository::insert ( ilOrgUnitPosition $position )

private

Definition at line 252 of file class.ilOrgUnitPositionDBRepository.php.

                                                        : 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;
    }

References $id, ilOrgUnitPosition\getAuthorities(), ilOrgUnitPosition\getCoreIdentifier(), ilOrgUnitPosition\getDescription(), ilOrgUnitPosition\getTitle(), ilOrgUnitPosition\isCorePosition(), and ILIAS\GlobalScreen\Scope\Footer\Factory\withTitle().

Here is the call graph for this function:

◆ store()

ilOrgUnitPositionDBRepository::store ( ilOrgUnitPosition $position )

Saves position and its authorities.

Implements OrgUnitPositionRepository.

Definition at line 221 of file class.ilOrgUnitPositionDBRepository.php.

                                                      : 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;
    }

References ilOrgUnitPosition\getAuthorities(), ilOrgUnitPosition\getId(), and ilOrgUnitPosition\withAuthorities().

Here is the call graph for this function:

◆ update()

ilOrgUnitPositionDBRepository::update ( ilOrgUnitPosition $position )

private

Definition at line 276 of file class.ilOrgUnitPositionDBRepository.php.

                                                        : 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);
    }

References ilOrgUnitPosition\getCoreIdentifier(), ilOrgUnitPosition\getDescription(), ilOrgUnitPosition\getId(), ilOrgUnitPosition\getTitle(), and ilOrgUnitPosition\isCorePosition().

Here is the call graph for this function:

Field Documentation

◆ TABLE_NAME

const ilOrgUnitPositionDBRepository::TABLE_NAME = 'il_orgu_positions'

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

◆ TABLE_NAME_UA

const ilOrgUnitPositionDBRepository::TABLE_NAME_UA = 'il_orgu_ua'

private

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

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

components/ILIAS/OrgUnit/classes/Positions/class.ilOrgUnitPositionDBRepository.php

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ create()

◆ delete()

◆ get()

◆ getAllPositions()

◆ getAllPositionsCount()

◆ getArray()

◆ getAuthority()

◆ getAuthorityDescription()

◆ getPositionsForOrgUnit()

◆ getRows()

◆ getSingle()

◆ getTotalRowCount()

◆ insert()

◆ store()

◆ update()

Field Documentation

◆ TABLE_NAME

◆ TABLE_NAME_UA