ILIAS  release_9 Revision v9.13-25-g2c18ec4c24f
ilObjectProperties Class Reference
+ Collaboration diagram for ilObjectProperties:

Public Member Functions

 __construct (private ilObjectCoreProperties $core_properties, private ilObjectCorePropertiesRepository $core_properties_repository, private ilObjectAdditionalProperties $additional_properties, private ilObjectAdditionalPropertiesRepository $additional_properties_repository, private ilMD $meta_data)
 
 storeCoreProperties ()
 
 getOwner ()
 
 withOwner (int $owner)
 
 getImportId ()
 
 withImportId (string $import_id)
 
 getPropertyTitleAndDescription ()
 
 withPropertyTitleAndDescription (ilObjectPropertyTitleAndDescription $property_title_and_description)
 
 storePropertyTitleAndDescription (ilObjectPropertyTitleAndDescription $property_title_and_description)
 
 getPropertyIsOnline ()
 
 storePropertyIsOnline (ilObjectPropertyIsOnline $property_is_online)
 
 withPropertyIsOnline (ilObjectPropertyIsOnline $property_is_online)
 
 getPropertyTitleAndIconVisibility ()
 
 storePropertyTitleAndIconVisibility (ilObjectPropertyTitleAndIconVisibility $property_title_and_icon_visibility)
 
 getPropertyHeaderActionVisibility ()
 
 storePropertyHeaderActionVisibility (ilObjectPropertyHeaderActionVisibility $property_header_action_visibility)
 
 getPropertyInfoTabVisibility ()
 
 storePropertyInfoTabVisibility (ilObjectPropertyInfoTabVisibility $property_info_tab_visibility)
 
 getPropertyTileImage ()
 
 storePropertyTileImage (ilObjectPropertyTileImage $property_tile_image)
 
 getPropertyIcon ()
 
 storePropertyIcon (ilObjectPropertyIcon $property_icon)
 

Private Member Functions

 updateMetadataForTitleAndDescription (string $title, string $description)
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilObjectProperties::__construct ( private ilObjectCoreProperties  $core_properties,
private ilObjectCorePropertiesRepository  $core_properties_repository,
private ilObjectAdditionalProperties  $additional_properties,
private ilObjectAdditionalPropertiesRepository  $additional_properties_repository,
private ilMD  $meta_data 
)

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

31  {
32  }

Member Function Documentation

◆ getImportId()

ilObjectProperties::getImportId ( )

Definition at line 55 of file class.ilObjectProperties.php.

55  : string
56  {
57  return $this->core_properties->getImportId();
58  }

◆ getOwner()

ilObjectProperties::getOwner ( )

Definition at line 43 of file class.ilObjectProperties.php.

43  : int
44  {
45  return $this->core_properties->getOwner();
46  }

◆ getPropertyHeaderActionVisibility()

ilObjectProperties::getPropertyHeaderActionVisibility ( )

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

130  {
131  return $this->additional_properties->getPropertyHeaderActionVisibility();
132  }

◆ getPropertyIcon()

ilObjectProperties::getPropertyIcon ( )

Definition at line 171 of file class.ilObjectProperties.php.

172  {
173  return $this->additional_properties->getPropertyIcon();
174  }

◆ getPropertyInfoTabVisibility()

ilObjectProperties::getPropertyInfoTabVisibility ( )

Definition at line 143 of file class.ilObjectProperties.php.

144  {
145  return $this->additional_properties->getPropertyInfoTabVisibility();
146  }

◆ getPropertyIsOnline()

ilObjectProperties::getPropertyIsOnline ( )

Definition at line 94 of file class.ilObjectProperties.php.

95  {
96  return $this->core_properties->getPropertyIsOnline();
97  }

◆ getPropertyTileImage()

ilObjectProperties::getPropertyTileImage ( )

Definition at line 157 of file class.ilObjectProperties.php.

158  {
159  return $this->core_properties->getPropertyTileImage();
160  }

◆ getPropertyTitleAndDescription()

ilObjectProperties::getPropertyTitleAndDescription ( )

Definition at line 67 of file class.ilObjectProperties.php.

68  {
69  return $this->core_properties->getPropertyTitleAndDescription();
70  }

◆ getPropertyTitleAndIconVisibility()

ilObjectProperties::getPropertyTitleAndIconVisibility ( )

Definition at line 115 of file class.ilObjectProperties.php.

116  {
117  return $this->additional_properties->getPropertyTitleAndIconVisibility();
118  }

◆ storeCoreProperties()

ilObjectProperties::storeCoreProperties ( )

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

References updateMetadataForTitleAndDescription().

34  : void
35  {
36  $this->core_properties_repository->store($this->core_properties);
38  $this->core_properties->getPropertyTitleAndDescription()->getTitle(),
39  $this->core_properties->getPropertyTitleAndDescription()->getDescription()
40  );
41  }
updateMetadataForTitleAndDescription(string $title, string $description)
+ Here is the call graph for this function:

◆ storePropertyHeaderActionVisibility()

ilObjectProperties::storePropertyHeaderActionVisibility ( ilObjectPropertyHeaderActionVisibility  $property_header_action_visibility)

Definition at line 134 of file class.ilObjectProperties.php.

136  : void {
137  $this->additional_properties = $this->additional_properties_repository->store(
138  $this->additional_properties
139  ->withPropertyHeaderActionVisibility($property_header_action_visibility)
140  );
141  }

◆ storePropertyIcon()

ilObjectProperties::storePropertyIcon ( ilObjectPropertyIcon  $property_icon)

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

178  : void {
179  $this->additional_properties = $this->additional_properties_repository->store(
180  $this->additional_properties
181  ->withPropertyIcon($property_icon)
182  );
183  }

◆ storePropertyInfoTabVisibility()

ilObjectProperties::storePropertyInfoTabVisibility ( ilObjectPropertyInfoTabVisibility  $property_info_tab_visibility)

Definition at line 148 of file class.ilObjectProperties.php.

150  : void {
151  $this->additional_properties = $this->additional_properties_repository->store(
152  $this->additional_properties
153  ->withPropertyInfoTabVisibility($property_info_tab_visibility)
154  );
155  }

◆ storePropertyIsOnline()

ilObjectProperties::storePropertyIsOnline ( ilObjectPropertyIsOnline  $property_is_online)

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

99  : void
100  {
101  $this->core_properties = $this->core_properties_repository->store(
102  $this->core_properties->withPropertyIsOnline($property_is_online)
103  );
104  }

◆ storePropertyTileImage()

ilObjectProperties::storePropertyTileImage ( ilObjectPropertyTileImage  $property_tile_image)

Definition at line 162 of file class.ilObjectProperties.php.

164  : void {
165  $this->core_properties = $this->core_properties_repository->store(
166  $this->core_properties
167  ->withPropertyTileImage($property_tile_image)
168  );
169  }

◆ storePropertyTitleAndDescription()

ilObjectProperties::storePropertyTitleAndDescription ( ilObjectPropertyTitleAndDescription  $property_title_and_description)

Definition at line 81 of file class.ilObjectProperties.php.

References ilObjectPropertyTitleAndDescription\getLongDescription(), ilObjectPropertyTitleAndDescription\getTitle(), updateMetadataForTitleAndDescription(), and withPropertyTitleAndDescription().

83  : void {
84  $this->core_properties = $this->core_properties_repository->store(
85  $this->core_properties
86  ->withPropertyTitleAndDescription($property_title_and_description)
87  );
89  $property_title_and_description->getTitle(),
90  $property_title_and_description->getLongDescription()
91  );
92  }
withPropertyTitleAndDescription(ilObjectPropertyTitleAndDescription $property_title_and_description)
updateMetadataForTitleAndDescription(string $title, string $description)
+ Here is the call graph for this function:

◆ storePropertyTitleAndIconVisibility()

ilObjectProperties::storePropertyTitleAndIconVisibility ( ilObjectPropertyTitleAndIconVisibility  $property_title_and_icon_visibility)

Definition at line 120 of file class.ilObjectProperties.php.

122  : void {
123  $this->additional_properties = $this->additional_properties_repository->store(
124  $this->additional_properties
125  ->withPropertyTitleAndIconVisibility($property_title_and_icon_visibility)
126  );
127  }

◆ updateMetadataForTitleAndDescription()

ilObjectProperties::updateMetadataForTitleAndDescription ( string  $title,
string  $description 
)
private

Definition at line 185 of file class.ilObjectProperties.php.

Referenced by storeCoreProperties(), and storePropertyTitleAndDescription().

188  : void {
189  $general_metadata = $this->meta_data->getGeneral();
190  if ($general_metadata === null) {
191  return;
192  }
193  $general_metadata->setTitle($title);
194 
195  // sets first description (maybe not appropriate)
196  $general_metadata_ids = $general_metadata->getDescriptionIds();
197  if ($general_metadata_ids !== []) {
198  $general_metadata_description = $general_metadata->getDescription($general_metadata_ids[0]);
199  $general_metadata_description->setDescription($description);
200  $general_metadata_description->update();
201  }
202  $general_metadata->update();
203  }
+ Here is the caller graph for this function:

◆ withImportId()

ilObjectProperties::withImportId ( string  $import_id)

Definition at line 60 of file class.ilObjectProperties.php.

60  : self
61  {
62  $clone = clone $this;
63  $clone->core_properties = $this->core_properties->withImportId($import_id);
64  return $clone;
65  }

◆ withOwner()

ilObjectProperties::withOwner ( int  $owner)

Definition at line 48 of file class.ilObjectProperties.php.

48  : self
49  {
50  $clone = clone $this;
51  $clone->core_properties = $this->core_properties->withOwner($owner);
52  return $clone;
53  }

◆ withPropertyIsOnline()

ilObjectProperties::withPropertyIsOnline ( ilObjectPropertyIsOnline  $property_is_online)

Definition at line 106 of file class.ilObjectProperties.php.

108  : self {
109  $clone = clone $this;
110  $clone->core_properties = $this->core_properties
111  ->withPropertyIsOnline($property_is_online);
112  return $clone;
113  }

◆ withPropertyTitleAndDescription()

ilObjectProperties::withPropertyTitleAndDescription ( ilObjectPropertyTitleAndDescription  $property_title_and_description)

Definition at line 72 of file class.ilObjectProperties.php.

Referenced by storePropertyTitleAndDescription().

74  : self {
75  $clone = clone $this;
76  $clone->core_properties = $this->core_properties
77  ->withPropertyTitleAndDescription($property_title_and_description);
78  return $clone;
79  }
+ Here is the caller graph for this function:

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