ilObjectCorePropertiesCachedRepository Class Reference

Inheritance diagram for ilObjectCorePropertiesCachedRepository:

Collaboration diagram for ilObjectCorePropertiesCachedRepository:

Public Member Functions
	__construct (private readonly ilDBInterface $database, private readonly ilObjectDefinition $obj_definition, private readonly ResourceStorageService $storage_services, private readonly ilObjectTileImageStakeholder $storage_stakeholder, private readonly ilObjectTileImageFlavourDefinition $flavour_definition, private readonly ObjectTypeSpecificPropertiesFactory $object_type_specific_properties_factory)
	preload (array $object_ids)
	resetPreloadedData ()
	getFor (?int $object_id, ?string $type=null)
	store (ilObjectCoreProperties $properties)
Public Member Functions inherited from ilObjectCorePropertiesRepository
	getFor (int $object_id, ?string $type=null)

Protected Member Functions
	retrieveDataForObjectId (int $object_id)
	retrieveDataForObjectIds (array $object_ids)
	retrieveDataForWhereClause (string $where)
	storeLongDescription (string $long_description, array $where)

Private Member Functions
	deleteOldTileImage (ilObjectTileImage $tile_image)
	getDefaultCoreProperties (?string $type)

Private Attributes
const	CORE_PROPERTIES_TABLE = 'object_data'
const	DESCRIPTION_TABLE = 'object_description'
array	$data_cache = []

Detailed Description

Author

Stephan Kergomard

Definition at line 33 of file ilObjectCorePropertiesCachedRepository.php.

Constructor & Destructor Documentation

__construct()

ilObjectCorePropertiesCachedRepository::__construct	(	private readonly ilDBInterface	$database,
		private readonly ilObjectDefinition	$obj_definition,
		private readonly ResourceStorageService	$storage_services,
		private readonly ilObjectTileImageStakeholder	$storage_stakeholder,
		private readonly ilObjectTileImageFlavourDefinition	$flavour_definition,
		private readonly ObjectTypeSpecificPropertiesFactory	$object_type_specific_properties_factory
	)

Definition at line 40 of file ilObjectCorePropertiesCachedRepository.php.

      {
    }

Member Function Documentation

deleteOldTileImage()

ilObjectCorePropertiesCachedRepository::deleteOldTileImage ( ilObjectTileImage  $tile_image )

private

Definition at line 154 of file ilObjectCorePropertiesCachedRepository.php.

References ILIAS\Object\Properties\CoreProperties\TileImage\ilObjectTileImage\getRid(), and null.

Referenced by store().

                                                                      : void
    {
        if ($tile_image->getRid() === null) {
            return;
        }

        $i = $this->storage_services->manage()->find($tile_image->getRid());
        if ($i === null) {
            return;
        }

        $this->storage_services->manage()->remove(
            $i,
            $this->storage_stakeholder
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultCoreProperties()

ilObjectCorePropertiesCachedRepository::getDefaultCoreProperties ( ?string  $type )

private

Definition at line 171 of file ilObjectCorePropertiesCachedRepository.php.

References ilObjectCoreProperties\withType().

Referenced by getFor().

                                                            : ilObjectCoreProperties
    {
        return (new ilObjectCoreProperties(
            new ilObjectPropertyTitleAndDescription(),
            new ilObjectPropertyIsOnline(),
            new ilObjectPropertyTileImage()
        ))->withType($type);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFor()

ilObjectCorePropertiesCachedRepository::getFor	(	?int	$object_id,
		?string	$type = null
	)

Definition at line 60 of file ilObjectCorePropertiesCachedRepository.php.

References $data, getDefaultCoreProperties(), null, and retrieveDataForObjectId().

                                                                 : ilObjectCoreProperties
    {
        if ($object_id === null
            || $object_id === 0) {
            return $this->getDefaultCoreProperties($type);
        }

        if (!isset($this->data_cache[$object_id])) {
            $this->data_cache[$object_id] = $this->retrieveDataForObjectId($object_id);
        }

        $data = $this->data_cache[$object_id];

        $object_type_specific_properties = $this->object_type_specific_properties_factory->getForObjectTypeString($data['type']);
        $providers = null;
        $modifications = null;
        if ($object_type_specific_properties !== null) {
            $providers = $object_type_specific_properties->getProviders();
            $modifications = $object_type_specific_properties->getModifications();
        }
        return new ilObjectCoreProperties(
            new ilObjectPropertyTitleAndDescription(
                array_shift($data),
                array_shift($data),
                $modifications
            ),
            new ilObjectPropertyIsOnline(array_shift($data)),
            new ilObjectPropertyTileImage(
                new ilObjectTileImage(
                    $object_id,
                    $data['type'],
                    array_shift($data),
                    $this->storage_services,
                    $this->storage_stakeholder,
                    $this->flavour_definition,
                    $providers
                )
            ),
            $data
        );
    }

Here is the call graph for this function:

preload()

ilObjectCorePropertiesCachedRepository::preload

(

array

$ids

)

Parameters

array<int>

$ids

Implements ilObjectCorePropertiesRepository.

Definition at line 50 of file ilObjectCorePropertiesCachedRepository.php.

References retrieveDataForObjectIds().

                                              : void
    {
        $this->data_cache += $this->retrieveDataForObjectIds($object_ids);
    }

Here is the call graph for this function:

resetPreloadedData()

ilObjectCorePropertiesCachedRepository::resetPreloadedData

(

)

Implements ilObjectCorePropertiesRepository.

Definition at line 55 of file ilObjectCorePropertiesCachedRepository.php.

                                        : void
    {
        $this->data_cache = [];
    }

retrieveDataForObjectId()

ilObjectCorePropertiesCachedRepository::retrieveDataForObjectId ( int  $object_id )

protected

Returns

array<mixed>

Definition at line 183 of file ilObjectCorePropertiesCachedRepository.php.

References $data, and retrieveDataForWhereClause().

Referenced by getFor().

                                                              : array
    {
        $where = 'WHERE obj.obj_id=' . $this->database->quote($object_id, 'integer');
        $data = $this->retrieveDataForWhereClause($where);

        if ($data === []) {
            throw new \Exception('The object with the following id does not exist: '
                . (string) $object_id);
        }

        return $data[$object_id];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

retrieveDataForObjectIds()

ilObjectCorePropertiesCachedRepository::retrieveDataForObjectIds ( array  $object_ids )

protected

Parameters

array<int>

$object_ids

Definition at line 199 of file ilObjectCorePropertiesCachedRepository.php.

References retrieveDataForWhereClause(), and ilDBConstants\T_INTEGER.

Referenced by preload().

                                                                  : array
    {
        $where = 'WHERE ' . $this->database->in('obj.obj_id', $object_ids, false, ilDBConstants::T_INTEGER);
        return $this->retrieveDataForWhereClause($where);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

retrieveDataForWhereClause()

ilObjectCorePropertiesCachedRepository::retrieveDataForWhereClause ( string  $where )

protected

Definition at line 205 of file ilObjectCorePropertiesCachedRepository.php.

References $data, and null.

Referenced by retrieveDataForObjectId(), and retrieveDataForObjectIds().

                                                                : array
    {
        $query = 'SELECT '
            . 'obj.obj_id, obj.type, obj.title, obj.description, obj.owner,' . PHP_EOL
            . 'obj.create_date, obj.last_update, obj.import_id, obj.offline,' . PHP_EOL
            . 'obj.tile_image_rid, descr.description' . PHP_EOL
            . 'FROM ' . self::CORE_PROPERTIES_TABLE . ' AS obj' . PHP_EOL
            . 'LEFT JOIN ' . self::DESCRIPTION_TABLE . ' AS descr' . PHP_EOL
            . 'ON obj.obj_id = descr.obj_id' . PHP_EOL
            . $where;

        $statement = $this->database->query($query);
        $num_rows = $this->database->numRows($statement);

        if ($num_rows === 0) {
            return [];
        }

        $data = [];
        while ($row = $this->database->fetchAssoc($statement)) {
            $data[$row['obj_id']] = [
                'title' => $row['title'],
                'long_description' => $row['description'] ?? '',
                'is_online' => !((bool) $row['offline']),
                'tile_image_rid' => $row['tile_image_rid'],
                'object_id' => $row['obj_id'],
                'type' => $row['type'],
                'owner' => $row['owner'],
                'import_id' => $row['import_id'],
                'create_date' => $row['create_date'] !== null ? new DateTimeImmutable($row['create_date']) : null,
                'update_date' => $row['last_update'] !== null ? new DateTimeImmutable($row['last_update']) : null
            ];
        }

        return $data;
    }

Here is the caller graph for this function:

store()

ilObjectCorePropertiesCachedRepository::store

(

ilObjectCoreProperties

$properties

)

Remove with ILIAS10

Remove with ILIAS10

Implements ilObjectCorePropertiesRepository.

Definition at line 102 of file ilObjectCorePropertiesCachedRepository.php.

References deleteOldTileImage(), ilObjectCoreProperties\getCreateDate(), ilObjectCoreProperties\getImportId(), ilObjectCoreProperties\getObjectId(), ilObjectCoreProperties\getOwner(), ilObjectCoreProperties\getPropertyIsOnline(), ilObjectCoreProperties\getPropertyTileImage(), ilObjectCoreProperties\getPropertyTitleAndDescription(), ilObjectCoreProperties\getType(), ILIAS\Repository\int(), null, storeLongDescription(), ilDBConstants\T_DATETIME, ilDBConstants\T_INTEGER, ilDBConstants\T_TEXT, and ilObjectCoreProperties\withPropertyTileImage().

                                                             : ilObjectCoreProperties
    {
        if ($properties->getObjectId() === null || $properties->getOwner() === null) {
            throw new \Exception('The current configuration cannot be saved.');
        }

        if ($properties->getPropertyTileImage()->getDeletedFlag()) {
            $this->deleteOldTileImage($properties->getPropertyTileImage()->getTileImage());
            $properties = $properties->withPropertyTileImage(
                $properties->getPropertyTileImage()->withTileImage(
                    $properties->getPropertyTileImage()->getTileImage()->withRid(null)
                )
            );
            $properties->getPropertyTileImage()->getTileImage()->deleteLegacyTileImage();
        }

        if ($properties->getPropertyTileImage()->getTileImage()->getRid() !== null) {
            $properties->getPropertyTileImage()->getTileImage()->deleteLegacyTileImage();
        }

        $where = [
            'obj_id' => [ilDBConstants::T_INTEGER, $properties->getObjectId()]
        ];

        $storage_array = [
            'type' => [ilDBConstants::T_TEXT, $properties->getType()],
            'title' => [ilDBConstants::T_TEXT, $properties->getPropertyTitleAndDescription()->getTitle()],
            'description' => [ilDBConstants::T_TEXT, $properties->getPropertyTitleAndDescription()->getDescription()],
            'owner' => [ilDBConstants::T_INTEGER, $properties->getOwner()],
            'create_date' => [ilDBConstants::T_DATETIME, $properties->getCreateDate()?->format('Y-m-d H:i:s')],
            'last_update' => [ilDBConstants::T_DATETIME, (new DateTimeImmutable('now', new DateTimeZone('UTC')))->format('Y-m-d H:i:s')],
            'import_id' => [ilDBConstants::T_TEXT, $properties->getImportId()],
            'offline' => [ilDBConstants::T_INTEGER, (int) !$properties->getPropertyIsOnline()->getIsOnline()],
            'tile_image_rid' => [ilDBConstants::T_TEXT, $properties->getPropertyTileImage()->getTileImage()->getRid()]
        ];
        $this->database->update(self::CORE_PROPERTIES_TABLE, $storage_array, $where);

        if ($this->obj_definition->isRBACObject($properties->getType())) {
            $this->storeLongDescription($properties->getPropertyTitleAndDescription()->getLongDescription(), $where);
        }

        unset($this->data_cache[$properties->getObjectId()]);

        return $properties;
    }

Here is the call graph for this function:

storeLongDescription()

ilObjectCorePropertiesCachedRepository::storeLongDescription ( string  $long_description, array  $where  )

protected

Definition at line 242 of file ilObjectCorePropertiesCachedRepository.php.

References ilDBConstants\T_TEXT.

Referenced by store().

                                                                                   : void
    {
        $description_array = [
            'description' => [ilDBConstants::T_TEXT, $long_description]
        ];
        $this->database->update(self::DESCRIPTION_TABLE, $description_array, $where);
    }

Here is the caller graph for this function:

Field Documentation

$data_cache

array ilObjectCorePropertiesCachedRepository::$data_cache = []

private

Definition at line 38 of file ilObjectCorePropertiesCachedRepository.php.

CORE_PROPERTIES_TABLE

const ilObjectCorePropertiesCachedRepository::CORE_PROPERTIES_TABLE = 'object_data'

private

Definition at line 35 of file ilObjectCorePropertiesCachedRepository.php.

DESCRIPTION_TABLE

const ilObjectCorePropertiesCachedRepository::DESCRIPTION_TABLE = 'object_description'

private

Definition at line 36 of file ilObjectCorePropertiesCachedRepository.php.

---

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

• components/ILIAS/ILIASObject/classes/Properties/CoreProperties/ilObjectCorePropertiesCachedRepository.php