ilOrgUnitOperationContextDBRepository Class Reference

Inheritance diagram for ilOrgUnitOperationContextDBRepository:

Collaboration diagram for ilOrgUnitOperationContextDBRepository:

Public Member Functions
	__construct (ilDBInterface $db)
	get (string $context, ?string $parent_context)
	Get a context If the context does not exist, it is created. More...
	store (ilOrgUnitOperationContext $operation_context)
	Store context to db. More...
	delete (string $context)
	Delete context by name Returns false, if no context is found. More...
	find (string $context)
	Find an existing context Returns null if no context is found. More...
	getById (int $id)
	Get context by id Returns null if no context is found. More...
	getByRefId (int $ref_id)
	Get context by ref_id Returns null if no context is found. More...
	getByObjId (int $obj_id)
	Get context by obj_id Returns null if no context is found. More...

Data Fields
const	TABLE_NAME = 'il_orgu_op_contexts'

Protected Attributes
ilDBInterface	$db

Private Member Functions
	insert (ilOrgUnitOperationContext $operation_context)
	update (ilOrgUnitOperationContext $operation_context)
	appendPath (ilOrgUnitOperationContext $operation_context, ?int $next=null)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilOrgUnitOperationContextDBRepository::__construct

(

ilDBInterface

$db

)

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

References $db.

    {
        $this->db = $db;
    }

Member Function Documentation

appendPath()

ilOrgUnitOperationContextDBRepository::appendPath ( ilOrgUnitOperationContext  $operation_context, ?int  $next = null  )

private

Definition at line 183 of file class.ilOrgUnitOperationContextDBRepository.php.

References getById(), ilOrgUnitOperationContext\getId(), ilOrgUnitOperationContext\getParentContextId(), ilOrgUnitOperationContext\getPathIds(), ilOrgUnitOperationContext\getPathNames(), and ilOrgUnitOperationContext\withPathNames().

Referenced by find(), get(), getById(), insert(), and store().

                                                                                                : ilOrgUnitOperationContext
    {
        $parent_context_id = ($next >= 0) ? $next : $operation_context->getParentContextId();
        if ($parent_context_id > 0) {
            $parent = $this->getById($parent_context_id);
            if ($parent) {
                $path_names = $operation_context->getPathNames();
                $path_names[] = $parent->getContext();
                $path_ids = $operation_context->getPathIds();
                $path_ids[] = $parent->getId();

                $operation_context = $operation_context
                    ->withPathNames($path_names)
                    ->withPathIds($path_ids);

                $operation_context = $this->appendPath($operation_context, $parent->getId());
            }
        }
        return $operation_context;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilOrgUnitOperationContextDBRepository::delete

(

string

$context

)

Delete context by name Returns false, if no context is found.

Implements OrgUnitOperationContextRepository.

Definition at line 111 of file class.ilOrgUnitOperationContextDBRepository.php.

References find().

                                           : bool
    {
        $operation_context = $this->find($context);
        if (!$operation_context) {
            return false;
        }

        $query = 'DELETE FROM ' . self::TABLE_NAME . PHP_EOL
                . ' WHERE id = ' . $this->db->quote($operation_context->getId(), 'integer');
        $rows = $this->db->manipulate($query);
        if ($rows > 0) {
            return true;
        }

        return false;
    }

Here is the call graph for this function:

find()

ilOrgUnitOperationContextDBRepository::find

(

string

$context

)

Find an existing context Returns null if no context is found.

Implements OrgUnitOperationContextRepository.

Definition at line 128 of file class.ilOrgUnitOperationContextDBRepository.php.

References $res, appendPath(), and null.

Referenced by delete(), get(), getByObjId(), and getByRefId().

                                         : ?ilOrgUnitOperationContext
    {
        $query = 'SELECT id, context, parent_context_id FROM' . PHP_EOL
            . self::TABLE_NAME
            . ' WHERE ' . self::TABLE_NAME . '.context = ' . $this->db->quote($context, 'string');
        $res = $this->db->query($query);
        if ($res->numRows() === 0) {
            return null;
        }

        $rec = $this->db->fetchAssoc($res);
        $operation_context = (new ilOrgUnitOperationContext((int) $rec['id']))
            ->withContext((string) $rec['context'])
            ->withParentContextId((int) $rec['parent_context_id'])
            ->withPathNames([(string) $rec['context']])
            ->withPathIds([(int) $rec['id']]);
        $operation_context = $this->appendPath($operation_context);

        return $operation_context;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

get()

ilOrgUnitOperationContextDBRepository::get	(	string	$context,
		?string	$parent_context
	)

Get a context If the context does not exist, it is created.

Exceptions

ilException

Implements OrgUnitOperationContextRepository.

Definition at line 32 of file class.ilOrgUnitOperationContextDBRepository.php.

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

                                                                 : ilOrgUnitOperationContext
    {
        $found_context = $this->find($context);
        if ($found_context) {
            return $found_context;
        }

        $parent_id = 0;
        if ($parent_context !== null) {
            $parent = $this->find($parent_context);
            if (!$parent) {
                throw new ilException("Parent context not found");
            }
            $parent_id = $parent->getId();
        }

        $context = (new ilOrgUnitOperationContext())
            ->withContext($context)
            ->withParentContextId($parent_id);
        $this->store($context);

        $context = $context
            ->withPathNames([$context->getContext()])
            ->withPathIds([$context->getId()]);
        $context = $this->appendPath($context);

        return $context;
    }

Here is the call graph for this function:

getById()

ilOrgUnitOperationContextDBRepository::getById

(

int

$id

)

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

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

Deprecated:

Please refer to contexts by context name

Implements OrgUnitOperationContextRepository.

Definition at line 149 of file class.ilOrgUnitOperationContextDBRepository.php.

References $res, appendPath(), and null.

Referenced by appendPath().

                                    : ?ilOrgUnitOperationContext
    {
        $query = 'SELECT id, context, parent_context_id FROM' . PHP_EOL
            . self::TABLE_NAME
            . ' WHERE ' . self::TABLE_NAME . '.id = ' . $this->db->quote($id, 'integer');
        $res = $this->db->query($query);
        if ($res->numRows() === 0) {
            return null;
        }

        $rec = $this->db->fetchAssoc($res);
        $operation_context = (new ilOrgUnitOperationContext((int) $rec['id']))
            ->withContext((string) $rec['context'])
            ->withParentContextId((int) $rec['parent_context_id'])
            ->withPathNames([(string) $rec['context']])
            ->withPathIds([(int) $rec['id']]);
        $operation_context = $this->appendPath($operation_context);

        return $operation_context;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getByObjId()

ilOrgUnitOperationContextDBRepository::getByObjId

(

int

$obj_id

)

Get context by obj_id Returns null if no context is found.

Implements OrgUnitOperationContextRepository.

Definition at line 176 of file class.ilOrgUnitOperationContextDBRepository.php.

References ilObject\_lookupType(), and find().

                                           : ?ilOrgUnitOperationContext
    {
        $type_context = ilObject2::_lookupType($obj_id, false);
        return $this->find($type_context);
    }

Here is the call graph for this function:

getByRefId()

ilOrgUnitOperationContextDBRepository::getByRefId

(

int

$ref_id

)

Get context by ref_id Returns null if no context is found.

Implements OrgUnitOperationContextRepository.

Definition at line 170 of file class.ilOrgUnitOperationContextDBRepository.php.

References ilObject\_lookupType(), and find().

                                           : ?ilOrgUnitOperationContext
    {
        $type_context = ilObject2::_lookupType($ref_id, true);
        return $this->find($type_context);
    }

Here is the call graph for this function:

insert()

ilOrgUnitOperationContextDBRepository::insert ( ilOrgUnitOperationContext  $operation_context )

private

Definition at line 77 of file class.ilOrgUnitOperationContextDBRepository.php.

References $id, appendPath(), ilOrgUnitOperationContext\getContext(), and ilOrgUnitOperationContext\getParentContextId().

Referenced by store().

                                                                         : ilOrgUnitOperationContext
    {
        $id = $this->db->nextId(self::TABLE_NAME);

        $values = [
            'id' => [ 'integer', $id ],
            'context' => [ 'string', $operation_context->getContext() ],
            'parent_context_id' => [ 'integer', $operation_context->getParentContextId() ]
        ];

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

        $ret = (new ilOrgUnitOperationContext($id))
            ->withContext($operation_context->getContext())
            ->withParentContextId($operation_context->getParentContextId())
            ->withPathNames([$operation_context->getContext()])
            ->withPathIds([$id]);
        $ret = $this->appendPath($ret);

        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

store()

ilOrgUnitOperationContextDBRepository::store

(

ilOrgUnitOperationContext

$operation_context

)

Store context to db.

Implements OrgUnitOperationContextRepository.

Definition at line 62 of file class.ilOrgUnitOperationContextDBRepository.php.

References appendPath(), ilOrgUnitOperationContext\getContext(), ilOrgUnitOperationContext\getId(), insert(), update(), and ilOrgUnitOperationContext\withPathNames().

Referenced by get().

                                                                       : ilOrgUnitOperationContext
    {
        if ($operation_context->getId() === 0) {
            $operation_context = $this->insert($operation_context);
        } else {
            $this->update($operation_context);
            $operation_context = $operation_context
                ->withPathNames([$operation_context->getContext()])
                ->withPathIds([$operation_context->getId()]);
            $operation_context = $this->appendPath($operation_context);
        }

        return $operation_context;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilOrgUnitOperationContextDBRepository::update ( ilOrgUnitOperationContext  $operation_context )

private

Definition at line 99 of file class.ilOrgUnitOperationContextDBRepository.php.

References ilOrgUnitOperationContext\getContext(), ilOrgUnitOperationContext\getId(), and ilOrgUnitOperationContext\getParentContextId().

Referenced by store().

                                                                         : void
    {
        $where = [ 'id' => [ 'integer', $operation_context->getId() ] ];

        $values = [
            'context' => [ 'integer', $operation_context->getContext() ],
            'parent_context_id' => [ 'integer', $operation_context->getParentContextId() ]
        ];

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$db

ilDBInterface ilOrgUnitOperationContextDBRepository::$db

protected

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

Referenced by __construct().

TABLE_NAME

const ilOrgUnitOperationContextDBRepository::TABLE_NAME = 'il_orgu_op_contexts'

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

---

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

• components/ILIAS/OrgUnit/classes/Positions/Operation/class.ilOrgUnitOperationContextDBRepository.php