Collaboration diagram for ilObjectCoreProperties:

Public Member Functions
	__construct (private ilObjectPropertyTitleAndDescription $property_title_and_description, private ilObjectPropertyIsOnline $property_is_online, private ilObjectPropertyTileImage $property_tile_image, array $data=null)

	getObjectId ()

	getType ()

	withType (?string $type)

	getOwner ()

	withOwner (int $owner)

	getCreateDate ()

	getLastUpdateDate ()

	getImportId ()

	withImportId (string $import_id)

	getPropertyTitleAndDescription ()

	withPropertyTitleAndDescription (ilObjectPropertyTitleAndDescription $property_title_and_description)

	getPropertyIsOnline ()

	withPropertyIsOnline (ilObjectPropertyIsOnline $property_is_online)

	getPropertyTileImage ()

	withPropertyTileImage (ilObjectPropertyTileImage $property_tile_image)

Protected Member Functions
	checkDataArray (?array $data)

	setValuesByArray (array $data)

	checkTypesOfDataArray (array $data)

Private Attributes
const	FIELDS

const int	$object_id = null

string	$type = null

int	$owner = null

DateTimeImmutable	$create_date = null

DateTimeImmutable	$update_date = null

string	$import_id = ''

Detailed Description

Author: Stephan Kergomard

Definition at line 26 of file ilObjectCoreProperties.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectCoreProperties::__construct	(	private ilObjectPropertyTitleAndDescription	$property_title_and_description,
		private ilObjectPropertyIsOnline	$property_is_online,
		private ilObjectPropertyTileImage	$property_tile_image,
		array	$data = `null`
	)

Parameters

array<mixed> $data

Definition at line 47 of file ilObjectCoreProperties.php.

References $data, checkDataArray(), and setValuesByArray().

       {
         if ($this->checkDataArray($data)) {
             $this->setValuesByArray($data);
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkDataArray()

ilObjectCoreProperties::checkDataArray ( ?array $data )

protected

Parameters

array<mixed> $data

Definition at line 150 of file ilObjectCoreProperties.php.

References checkTypesOfDataArray().

Referenced by __construct().

                                                    : bool
     {
         if ($data === null) {
             return false;
         }
 
         if (array_diff_key(self::FIELDS, $data)
             || array_diff_key($data, self::FIELDS)) {
             return false;
         }
 
         if ($data['object_id'] === null || $data['owner'] === null) {
             return false;
         }
 
         if (!is_int($data['object_id']) || !is_int($data['owner'])) {
             return false;
         }
 
         return $this->checkTypesOfDataArray($data);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkTypesOfDataArray()

ilObjectCoreProperties::checkTypesOfDataArray ( array $data )

protected

Definition at line 183 of file ilObjectCoreProperties.php.

References ILIAS\LTI\ToolProvider\$key.

Referenced by checkDataArray().

                                                          : bool
     {
         foreach (self::FIELDS as $key => $value) {
             if ($data[$key] === null) {
                 continue;
             }
             if ($value === 'int' && !is_int($data[$key])) {
                 return false;
             }
             if ($value === 'text' && !is_string($data[$key])) {
                 return false;
             }
             if ($value === 'bool' && !is_bool($data[$key])) {
                 return false;
             }
             if ($value === 'DateTimeImmutable' && !$data[$key] instanceof DateTimeImmutable) {
                 return false;
             }
         }
         return true;
     }

Here is the caller graph for this function:

◆ getCreateDate()

ilObjectCoreProperties::getCreateDate ( )

Definition at line 87 of file ilObjectCoreProperties.php.

References $create_date.

Referenced by ilObjectCorePropertiesCachedRepository\store().

                                    : ?DateTimeImmutable
     {
         return $this->create_date;
     }

Here is the caller graph for this function:

◆ getImportId()

ilObjectCoreProperties::getImportId ( )

Definition at line 97 of file ilObjectCoreProperties.php.

Referenced by ilObjectCorePropertiesCachedRepository\store().

                                  : string
     {
         return $this->import_id ?? '';
     }

Here is the caller graph for this function:

◆ getLastUpdateDate()

ilObjectCoreProperties::getLastUpdateDate ( )

Definition at line 92 of file ilObjectCoreProperties.php.

References $update_date.

                                        : ?DateTimeImmutable
     {
         return $this->update_date;
     }

◆ getObjectId()

ilObjectCoreProperties::getObjectId ( )

Definition at line 58 of file ilObjectCoreProperties.php.

References $object_id.

Referenced by ilObjectCorePropertiesCachedRepository\store().

                                  : ?int
     {
         return $this->object_id;
     }

Here is the caller graph for this function:

◆ getOwner()

ilObjectCoreProperties::getOwner ( )

Definition at line 75 of file ilObjectCoreProperties.php.

References $owner.

Referenced by ilObjectCorePropertiesCachedRepository\store().

                               : ?int
     {
         return $this->owner;
     }

Here is the caller graph for this function:

◆ getPropertyIsOnline()

ilObjectCoreProperties::getPropertyIsOnline ( )

Definition at line 121 of file ilObjectCoreProperties.php.

Referenced by ilObjectCorePropertiesCachedRepository\store().

                                          : ilObjectPropertyIsOnline
     {
         return $this->property_is_online;
     }

Here is the caller graph for this function:

◆ getPropertyTileImage()

ilObjectCoreProperties::getPropertyTileImage ( )

Definition at line 133 of file ilObjectCoreProperties.php.

Referenced by ilObjectCorePropertiesCachedRepository\store().

                                           : ilObjectPropertyTileImage
     {
         return $this->property_tile_image;
     }

Here is the caller graph for this function:

◆ getPropertyTitleAndDescription()

ilObjectCoreProperties::getPropertyTitleAndDescription ( )

Definition at line 109 of file ilObjectCoreProperties.php.

Referenced by ilObjectCorePropertiesCachedRepository\store().

                                                     : ilObjectPropertyTitleAndDescription
     {
         return $this->property_title_and_description;
     }

Here is the caller graph for this function:

◆ getType()

ilObjectCoreProperties::getType ( )

Definition at line 63 of file ilObjectCoreProperties.php.

References $type.

Referenced by ilObjectCorePropertiesCachedRepository\store().

                              : ?string
     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ setValuesByArray()

ilObjectCoreProperties::setValuesByArray ( array $data )

protected

Parameters

array<mixed> $data

Definition at line 176 of file ilObjectCoreProperties.php.

References ILIAS\LTI\ToolProvider\$key.

Referenced by __construct().

                                                     : void
     {
         foreach ($data as $key => $value) {
             $this->$key = $value;
         }
     }

Here is the caller graph for this function:

◆ withImportId()

ilObjectCoreProperties::withImportId ( string $import_id )

Definition at line 102 of file ilObjectCoreProperties.php.

References $import_id.

                                                    : self
     {
         $clone = clone $this;
         $clone->import_id = $import_id;
         return $clone;
     }

◆ withOwner()

ilObjectCoreProperties::withOwner ( int $owner )

Definition at line 80 of file ilObjectCoreProperties.php.

References $owner.

                                          : self
     {
         $clone = clone $this;
         $clone->owner = $owner;
         return $clone;
     }

◆ withPropertyIsOnline()

ilObjectCoreProperties::withPropertyIsOnline ( ilObjectPropertyIsOnline $property_is_online )

Definition at line 126 of file ilObjectCoreProperties.php.

                                                                                       : self
     {
         $clone = clone $this;
         $clone->property_is_online = $property_is_online;
         return $clone;
     }

◆ withPropertyTileImage()

ilObjectCoreProperties::withPropertyTileImage ( ilObjectPropertyTileImage $property_tile_image )

Definition at line 138 of file ilObjectCoreProperties.php.

Referenced by ilObjectCorePropertiesCachedRepository\store().

                                                                                          : self
     {
         $clone = clone $this;
         $clone->property_tile_image = $property_tile_image;
         return $clone;
     }

Here is the caller graph for this function:

◆ withPropertyTitleAndDescription()

ilObjectCoreProperties::withPropertyTitleAndDescription ( ilObjectPropertyTitleAndDescription $property_title_and_description )

Definition at line 114 of file ilObjectCoreProperties.php.

                                                                                                                         : self
     {
         $clone = clone $this;
         $clone->property_title_and_description = $property_title_and_description;
         return $clone;
     }

◆ withType()

ilObjectCoreProperties::withType ( ?string $type )

Definition at line 68 of file ilObjectCoreProperties.php.

References $type.

Referenced by ilObjectCorePropertiesCachedRepository\getDefaultCoreProperties().

                                            : self
     {
         $clone = clone $this;
         $clone->type = $type;
         return $clone;
     }

Here is the caller graph for this function:

Field Documentation

◆ $create_date

DateTimeImmutable ilObjectCoreProperties::$create_date = null

private

Definition at line 39 of file ilObjectCoreProperties.php.

Referenced by getCreateDate().

◆ $import_id

string ilObjectCoreProperties::$import_id = ''

private

Definition at line 41 of file ilObjectCoreProperties.php.

Referenced by withImportId().

◆ $object_id

const int ilObjectCoreProperties::$object_id = null

private

Definition at line 36 of file ilObjectCoreProperties.php.

Referenced by getObjectId().

◆ $owner

int ilObjectCoreProperties::$owner = null

private

Definition at line 38 of file ilObjectCoreProperties.php.

Referenced by getOwner(), and withOwner().

◆ $type

string ilObjectCoreProperties::$type = null

private

Definition at line 37 of file ilObjectCoreProperties.php.

Referenced by getType(), and withType().

◆ $update_date

DateTimeImmutable ilObjectCoreProperties::$update_date = null

private

Definition at line 40 of file ilObjectCoreProperties.php.

Referenced by getLastUpdateDate().

◆ FIELDS

const ilObjectCoreProperties::FIELDS

private

Initial value:

= [

'object_id' => 'int'

Definition at line 28 of file ilObjectCoreProperties.php.

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

Services/Object/classes/Properties/CoreProperties/ilObjectCoreProperties.php

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkDataArray()

◆ checkTypesOfDataArray()

◆ getCreateDate()

◆ getImportId()

◆ getLastUpdateDate()

◆ getObjectId()

◆ getOwner()

◆ getPropertyIsOnline()

◆ getPropertyTileImage()

◆ getPropertyTitleAndDescription()

◆ getType()

◆ setValuesByArray()

◆ withImportId()

◆ withOwner()

◆ withPropertyIsOnline()

◆ withPropertyTileImage()

◆ withPropertyTitleAndDescription()

◆ withType()

Field Documentation

◆ $create_date

◆ $import_id

◆ $object_id

◆ $owner

◆ $type

◆ $update_date

◆ FIELDS