Inheritance diagram for ilOrgUnitOperationDBRepository:

Collaboration diagram for ilOrgUnitOperationDBRepository:

Public Member Functions
	__construct (ilDBInterface $db, ilOrgUnitOperationContextDBRepository $contextRepo)

	get (string $operation_string, string $description, array $contexts, int $list_order=0)
	Get an operation for each of the specified contexts If the operation does not exist for one or more contexts, it is created If any contexts do not exist yet, they are created as well. More...

	store (ilOrgUnitOperation $operation)
	Store operation to db. More...

	delete (ilOrgUnitOperation $operation)
	Delete an operation Returns false if the operation was not found. More...

	find (string $operation_string, string $context)
	Find an existing operation for a specified context Returns null if no operation is found. More...

	getById (int $operation_id)
	Get operation by id Returns null if no operation is found. More...

	getByName (string $operation_string)
	Get operation(s) by name. More...

	getOperationsByContextId (int $context_id)
	Get operations by context id. More...

	getOperationsByContextName (string $context)
	Get operations by context name. More...

	get (string $operation_string, string $description, array $contexts, int $list_order)
	Get an operation for each of the specified contexts If the operation does not exist for one or more contexts, it is created If any contexts do not exist yet, they are created as well. More...

	store (ilOrgUnitOperation $operation)
	Store operation to db. More...

	delete (ilOrgUnitOperation $operation)
	Delete an operation Returns false if the operation was not found. More...

	find (string $operation_string, string $context)
	Find an existing operation for a specified context Returns null if no operation is found. More...

	getById (int $operation_id)
	Get operation by id Returns null if no operation is found. More...

	getByName (string $operation_string)
	Get operation(s) by name. More...

	getOperationsByContextId (int $context_id)
	Get operations by context id. More...

	getOperationsByContextName (string $context)
	Get operations by context name. More...

Data Fields
const	TABLE_NAME = 'il_orgu_operations'

Protected Attributes
ilDBInterface	$db

ilOrgUnitOperationContextDBRepository	$contextRepo

Private Member Functions
	insert (ilOrgUnitOperation $operation)

	update (ilOrgUnitOperation $operation)

Detailed Description

Definition at line 21 of file class.ilOrgUnitOperationDBRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ilOrgUnitOperationDBRepository::__construct	(	ilDBInterface	$db,
		ilOrgUnitOperationContextDBRepository	$contextRepo
	)

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

    {
        $this->db = $db;
        $this->contextRepo = $contextRepo;
    }

References $contextRepo, and $db.

Member Function Documentation

◆ delete()

ilOrgUnitOperationDBRepository::delete ( ilOrgUnitOperation $operation )

Delete an operation Returns false if the operation was not found.

Implements OrgUnitOperationRepository.

Definition at line 105 of file class.ilOrgUnitOperationDBRepository.php.

                                                         : bool
    {
        if ($operation->getOperationId() === 0) {
            return false;
        }
 
        $query = 'DELETE FROM ' . self::TABLE_NAME . PHP_EOL
            . ' WHERE operation_id = ' . $this->db->quote($operation->getOperationId(), 'integer');
        $rows = $this->db->manipulate($query);
        if ($rows > 0) {
            return true;
        }
 
        return false;
    }

◆ find()

ilOrgUnitOperationDBRepository::find	(	string	$operation_string,
		string	$context
	)

Find an existing operation for a specified context Returns null if no operation is found.

Implements OrgUnitOperationRepository.

Definition at line 121 of file class.ilOrgUnitOperationDBRepository.php.

                                                                   : ?ilOrgUnitOperation
    {
        $context = $this->contextRepo->find($context);
        if (!$context) {
            return null;
        }
 
        $query = 'SELECT operation_id, operation_string, description, list_order, context_id FROM' . PHP_EOL
            . self::TABLE_NAME
            . ' WHERE ' . self::TABLE_NAME . '.operation_string = ' . $this->db->quote($operation_string, 'string') . PHP_EOL
            . ' AND ' . self::TABLE_NAME . '.context_id = ' . $this->db->quote($context->getId(), 'integer');
 
        $res = $this->db->query($query);
        if ($res->numRows() === 0) {
            return null;
        }
 
        $rec = $this->db->fetchAssoc($res);
        return (new ilOrgUnitOperation((int) $rec['operation_id']))
            ->withOperationString((string) $rec['operation_string'])
            ->withDescription((string) $rec["description"])
            ->withListOrder((int) $rec["list_order"])
            ->withContextId((int) $rec['context_id']);
    }

References $context, and $res.

Referenced by get().

Here is the caller graph for this function:

◆ get()

ilOrgUnitOperationDBRepository::get	(	string	$operation_string,
		string	$description,
		array	$contexts,
		int	$list_order = `0`
	)

Get an operation for each of the specified contexts If the operation does not exist for one or more contexts, it is created If any contexts do not exist yet, they are created as well.

Parameters

array $contexts string[]

Returns: array ilOrgUnitOperation[]

Implements OrgUnitOperationRepository.

Definition at line 34 of file class.ilOrgUnitOperationDBRepository.php.

                                                                                                            : array
    {
        $operations = [];
        foreach ($contexts as $context) {
            $operation = $this->find($operation_string, $context);
            if ($operation) {
                $operations[] = $operation;
                continue;
            }
 
            $operation_context = $this->contextRepo->get($context, null);
 
            $new_operation = (new ilOrgUnitOperation())
                ->withOperationString($operation_string)
                ->withDescription($description)
                ->withListOrder($list_order)
                ->withContextId($operation_context->getId());
            $new_operation = $this->store($new_operation);
 
            $operations[] = $new_operation;
        }
 
        return $operations;
    }

References $context, find(), and store().

Here is the call graph for this function:

◆ getById()

ilOrgUnitOperationDBRepository::getById ( int $operation_id )

Get operation by id Returns null if no operation is found.

This is only kept for backwards compatibility, but might be removed at a later date

Deprecated:: Please refer to operations by operation_string and context

Implements OrgUnitOperationRepository.

Definition at line 146 of file class.ilOrgUnitOperationDBRepository.php.

                                              : ?ilOrgUnitOperation
    {
        $query = 'SELECT operation_id, operation_string, description, list_order, context_id FROM' . PHP_EOL
            . self::TABLE_NAME
            . ' WHERE ' . self::TABLE_NAME . '.operation_id = ' . $this->db->quote($operation_id, 'integer');
 
        $res = $this->db->query($query);
        if ($res->numRows() === 0) {
            return null;
        }
 
        $rec = $this->db->fetchAssoc($res);
        return (new ilOrgUnitOperation((int) $rec['operation_id']))
            ->withOperationString((string) $rec['operation_string'])
            ->withDescription((string) $rec["description"])
            ->withListOrder((int) $rec["list_order"])
            ->withContextId((int) $rec['context_id']);
    }

References $res.

◆ getByName()

ilOrgUnitOperationDBRepository::getByName ( string $operation_string )

Get operation(s) by name.

Returns: array ilOrgUnitOperation[]

Implements OrgUnitOperationRepository.

Definition at line 165 of file class.ilOrgUnitOperationDBRepository.php.

                                                       : array
    {
        $query = 'SELECT operation_id, operation_string, description, list_order, context_id FROM' . PHP_EOL
            . self::TABLE_NAME
            . ' WHERE ' . self::TABLE_NAME . '.operation_string = ' . $this->db->quote($operation_string, 'string');
 
        $res = $this->db->query($query);
        if ($res->numRows() === 0) {
            return [];
        }
 
        $ret = [];
        while ($rec = $this->db->fetchAssoc($res)) {
            $operation = (new ilOrgUnitOperation((int) $rec['operation_id']))
                ->withOperationString((string) $rec['operation_string'])
                ->withDescription((string) $rec["description"])
                ->withListOrder((int) $rec["list_order"])
                ->withContextId((int) $rec['context_id']);
            $ret[] = $operation;
        }
 
        return $ret;
    }

References $res.

◆ getOperationsByContextId()

ilOrgUnitOperationDBRepository::getOperationsByContextId ( int $context_id )

Get operations by context id.

This is only kept for backwards compatibility, but might be removed at a later date

Deprecated:: Please refer to contexts by context name (see getOperationsByContextName)

Returns: array ilOrgUnitOperation[]

Implements OrgUnitOperationRepository.

Definition at line 189 of file class.ilOrgUnitOperationDBRepository.php.

                                                             : array
    {
        $operation_context = $this->contextRepo->getById($context_id);
        if (!$operation_context) {
            throw new ilException('Context with id ' . $context_id . ' does not exist!');
        }
 
        $query = 'SELECT operation_id, operation_string, description, list_order, context_id FROM' . PHP_EOL
            . self::TABLE_NAME
            . ' WHERE ' . self::TABLE_NAME . '.context_id = ' . $this->db->quote($operation_context->getId(), 'integer');
        $res = $this->db->query($query);
 
        $ret = [];
        while ($rec = $this->db->fetchAssoc($res)) {
            $operation = (new ilOrgUnitOperation((int) $rec['operation_id']))
                ->withOperationString((string) $rec['operation_string'])
                ->withDescription((string) $rec["description"])
                ->withListOrder((int) $rec["list_order"])
                ->withContextId((int) $rec['context_id']);
            $ret[] = $operation;
        }
 
        return $ret;
    }

References $res.

◆ getOperationsByContextName()

ilOrgUnitOperationDBRepository::getOperationsByContextName ( string $context )

Get operations by context name.

Returns: array ilOrgUnitOperation[]

Implements OrgUnitOperationRepository.

Definition at line 214 of file class.ilOrgUnitOperationDBRepository.php.

                                                               : array
    {
        $operation_context = $this->contextRepo->find($context);
        if (!$operation_context) {
            throw new ilException('Context ' . $context . ' does not exist!');
        }
 
        $query = 'SELECT operation_id, operation_string, description, list_order, context_id FROM' . PHP_EOL
            . self::TABLE_NAME
            . ' WHERE ' . self::TABLE_NAME . '.context_id = ' . $this->db->quote($operation_context->getId(), 'integer');
        $res = $this->db->query($query);
 
        $ret = [];
        while ($rec = $this->db->fetchAssoc($res)) {
            $operation = (new ilOrgUnitOperation((int) $rec['operation_id']))
                ->withOperationString((string) $rec['operation_string'])
                ->withDescription((string) $rec["description"])
                ->withListOrder((int) $rec["list_order"])
                ->withContextId((int) $rec['context_id']);
            $ret[] = $operation;
        }
 
        return $ret;
    }

References $context, and $res.

◆ insert()

ilOrgUnitOperationDBRepository::insert ( ilOrgUnitOperation $operation )

private

Definition at line 70 of file class.ilOrgUnitOperationDBRepository.php.

                                                          : ilOrgUnitOperation
    {
        $id = $this->db->nextId(self::TABLE_NAME);
 
        $values = [
            'operation_id' => [ 'integer', $id ],
            'operation_string' => [ 'string', $operation->getOperationString()],
            'description' => [ 'string', $operation->getDescription()],
            'list_order' => [ 'integer', $operation->getListOrder() ],
            'context_id' => [ 'integer', $operation->getContextId() ]
        ];
 
        $this->db->insert(self::TABLE_NAME, $values);
 
        return (new ilOrgUnitOperation($id))
            ->withOperationString($operation->getOperationString())
            ->withDescription($operation->getDescription())
            ->withListOrder($operation->getListOrder())
            ->withContextId($operation->getContextId());
    }

References $id, ilOrgUnitOperation\getContextId(), ilOrgUnitOperation\getDescription(), ilOrgUnitOperation\getListOrder(), and ilOrgUnitOperation\getOperationString().

Referenced by store().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ store()

ilOrgUnitOperationDBRepository::store ( ilOrgUnitOperation $operation )

Store operation to db.

Implements OrgUnitOperationRepository.

Definition at line 59 of file class.ilOrgUnitOperationDBRepository.php.

                                                        : ilOrgUnitOperation
    {
        if ($operation->getOperationId() === 0) {
            $operation = $this->insert($operation);
        } else {
            $this->update($operation);
        }
 
        return $operation;
    }

References ilOrgUnitOperation\getOperationId(), insert(), and update().

Referenced by get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilOrgUnitOperationDBRepository::update ( ilOrgUnitOperation $operation )

private

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

                                                          : void
    {
        $where = [ 'operation_id' => [ 'integer', $operation->getOperationId() ] ];
 
        $values = [
            'operation_string' => [ 'string', $operation->getOperationString()],
            'description' => [ 'string', $operation->getDescription()],
            'list_order' => [ 'integer', $operation->getListOrder() ],
            'context_id' => [ 'integer', $operation->getContextId() ]
        ];
 
        $this->db->update(self::TABLE_NAME, $values, $where);
    }

References ilOrgUnitOperation\getContextId(), ilOrgUnitOperation\getDescription(), ilOrgUnitOperation\getListOrder(), ilOrgUnitOperation\getOperationId(), and ilOrgUnitOperation\getOperationString().

Referenced by store().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $contextRepo

ilOrgUnitOperationContextDBRepository ilOrgUnitOperationDBRepository::$contextRepo

protected

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

Referenced by __construct().

◆ $db

ilDBInterface ilOrgUnitOperationDBRepository::$db

protected

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

Referenced by __construct().

◆ TABLE_NAME

const ilOrgUnitOperationDBRepository::TABLE_NAME = 'il_orgu_operations'

Definition at line 23 of file class.ilOrgUnitOperationDBRepository.php.

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

components/ILIAS/OrgUnit/classes/Positions/Operation/class.ilOrgUnitOperationDBRepository.php

Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ find()

◆ get()

◆ getById()

◆ getByName()

◆ getOperationsByContextId()

◆ getOperationsByContextName()

◆ insert()

◆ store()

◆ update()

Field Documentation

◆ $contextRepo

◆ $db

◆ TABLE_NAME