Functions
	initStdObjProperties (Container $DIC)

	addStdTitleAndDescription (int $obj_id, string $type)

	addStdTitle (int $obj_id, string $type)

	saveStdTitleAndDescription (int $obj_id, string $type)

	saveStdTitle (int $obj_id, string $type)

	addStdTile (int $obj_id, string $type)

	saveStdTile (int $obj_id, string $type)

	addOnline (int $obj_id, string $type)

	saveOnline (int $obj_id, string $type)

	addStdAvailability (int $ref_id, $visibility_info="")

	saveStdAvailability (int $ref_id)

	addAdditionalFeatures (int $obj_id, array $services)

	saveAdditionalFeatures (int $obj_id, array $services)

	addDidacticTemplates (string $type, int $ref_id, bool $creation_mode, array $additional_template_options=[])

	buildDidacticTemplateOptions (string $type, int $ref_id, array $additional_template_options=[])

	redirectToDidacticConfirmationIfChanged (int $ref_id, string $type, string $gui_class, array $additional_template_options=[])

	getDidacticTemplateIdFromRequest ()

Variables
trait	StdObjProperties

Function Documentation

◆ addAdditionalFeatures()

ILIAS\Repository\Form\addAdditionalFeatures	(	int	$obj_id,
		array	$services
	)

Definition at line 190 of file trait.StdObjProperties.php.

References $DIC, $lng, ilContainer\_lookupContainerSetting(), ilObjectServiceSettingsGUI\CUSTOM_METADATA, and ilObjectServiceSettingsGUI\TAXONOMIES.

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm().

      : self {
         global $DIC;
 
         $lng = $DIC->language();
 
         $lng->loadLanguageModule("obj");
 
         $form = $this->section("add", $lng->txt("obj_features"));
 
         // (local) custom metadata
         if (in_array(\ilObjectServiceSettingsGUI::CUSTOM_METADATA, $services)) {
             $form = $this->checkbox(
                 \ilObjectServiceSettingsGUI::CUSTOM_METADATA,
                 $lng->txt('obj_tool_setting_custom_metadata'),
                 $lng->txt('obj_tool_setting_custom_metadata_info'),
                 (bool) \ilContainer::_lookupContainerSetting(
                     $obj_id,
                     \ilObjectServiceSettingsGUI::CUSTOM_METADATA
                 )
             );
         }
 
         // taxonomies
         if (in_array(\ilObjectServiceSettingsGUI::TAXONOMIES, $services)) {
             $form = $this->checkbox(
                 \ilObjectServiceSettingsGUI::TAXONOMIES,
                 $lng->txt('obj_tool_setting_taxonomies'),
                 "",
                 (bool) \ilContainer::_lookupContainerSetting(
                     $obj_id,
                     \ilObjectServiceSettingsGUI::TAXONOMIES
                 )
             );
         }
 
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addDidacticTemplates()

ILIAS\Repository\Form\addDidacticTemplates	(	string	$type,
		int	$ref_id,
		bool	$creation_mode,
		array	$additional_template_options = `[]`
	)

Definition at line 248 of file trait.StdObjProperties.php.

References $data, $id, ILIAS\Repository\Form\buildDidacticTemplateOptions(), ILIAS\Repository\lng(), and ilDidacticTemplateObjSettings\lookupTemplateId().

      : self {
         list($existing_exclusive, $options) = $this->buildDidacticTemplateOptions(
             $type,
             $ref_id,
             $additional_template_options
         );
         if (sizeof($options) < 2) {
             return $this;
         }
 
         // workaround for containers in edit mode
         if (!$creation_mode) {
             $current_value = 'dtpl_' . \ilDidacticTemplateObjSettings::lookupTemplateId($ref_id);
 
             if (!in_array(
                 $current_value,
                 array_keys($options)
             ) || ($existing_exclusive && $current_value == "dtpl_0")) {
                 //add or rename actual value to not available
                 $options[$current_value] = [$this->lng->txt('not_available')];
             }
         } else {
             if ($existing_exclusive) {
                 //if an exclusive template exists use the second template as default value - Whatever the f*** that means!
                 $keys = array_keys($options);
                 $current_value = $keys[1];
             } else {
                 $current_value = 'dtpl_0';
             }
         }
 
         $form = $this->radio(
             'didactic_type',
             $this->lng->txt('type'),
             "",
             $current_value
         );
 
         foreach ($options as $id => $data) {
             /*
             if ($existing_exclusive && $id == 'dtpl_0') {
                 //set default disabled if an exclusive template exists
                 $option->setDisabled(true);
             }*/
             $form = $this->radioOption(
                 (string) $id,
                 $data[0] ?? '',
                 $data[1] ?? ''
             );
         }
         return $form;
     }

Here is the call graph for this function:

◆ addOnline()

ILIAS\Repository\Form\addOnline	(	int	$obj_id,
		string	$type
	)

Definition at line 109 of file trait.StdObjProperties.php.

References ILIAS\Repository\$refinery, ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\edit(), ILIAS\Exercise\Settings\SettingsGUI\getEditForm(), ILIAS\SurveyQuestionPool\Settings\SettingsGUI\getEditForm(), ILIAS\Wiki\Settings\SettingsGUI\getEditForm(), and ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm().

      : FormAdapterGUI {
         $obj_prop = $this->object_prop->getFor($obj_id, $type);
         $input = $obj_prop->getPropertyIsOnline()
                           ->toForm($this->lng, $this->ui->factory()->input()->field(), $this->refinery);
         $this->addField("is_online", $input, true);
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addStdAvailability()

ILIAS\Repository\Form\addStdAvailability	(	int	$ref_id,
			$visibility_info = `""`
	)

Definition at line 128 of file trait.StdObjProperties.php.

References $lng, ilObjectActivation\getItem(), IL_CAL_UNIX, ILIAS\Repository\int(), ILIAS\Repository\lng(), and ilObjectActivation\TIMINGS_ACTIVATION.

                                                                           : self
     {
         $lng = $this->lng;
         $activation = \ilObjectActivation::getItem($ref_id);
         $start = $end = $visibility = null;
         if (($activation["timing_type"] ?? null) === \ilObjectActivation::TIMINGS_ACTIVATION) {
             $start = (int) $activation["timing_start"];
             $end = (int) $activation["timing_end"];
             $visibility = (bool) $activation["visible"];
         }
         $enabled = ($end > 0) || ($start > 0);
         $form = $this
             ->optional(
                 "limited",
                 $lng->txt("rep_time_based_availability"),
                 "",
                 $enabled
             )
             ->dateTimeDuration(
                 "availability",
                 $this->lng->txt("rep_time_period"),
                 "",
                 new \ilDateTime($start, IL_CAL_UNIX),
                 new \ilDateTime($end, IL_CAL_UNIX)
             )
             ->checkbox(
                 "visibility",
                 $this->lng->txt("rep_activation_limited_visibility"),
                 $visibility_info,
                 $visibility
             )
             ->end();
         return $form;
     }

Here is the call graph for this function:

◆ addStdTile()

ILIAS\Repository\Form\addStdTile	(	int	$obj_id,
		string	$type
	)

Definition at line 87 of file trait.StdObjProperties.php.

References ILIAS\Repository\$refinery, ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\edit(), ILIAS\Exercise\Settings\SettingsGUI\getEditForm(), ILIAS\SurveyQuestionPool\Settings\SettingsGUI\getEditForm(), ILIAS\Wiki\Settings\SettingsGUI\getEditForm(), and ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm().

      : FormAdapterGUI {
         $obj_prop = $this->object_prop->getFor($obj_id, $type);
         $input = $obj_prop->getPropertyTileImage()
                           ->toForm($this->lng, $this->ui->factory()->input()->field(), $this->refinery);
         $this->addField("tile", $input, true);
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addStdTitle()

ILIAS\Repository\Form\addStdTitle	(	int	$obj_id,
		string	$type
	)

Definition at line 49 of file trait.StdObjProperties.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Repository\$refinery, ILIAS\UI\Implementation\Component\Input\getInputs(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by ilObjPortfolioGUI\getCreationForm().

      : FormAdapterGUI {
         $obj_prop = $this->object_prop->getFor($obj_id, $type);
         $inputs = $obj_prop
             ->getPropertyTitleAndDescription()
             ->toForm($this->lng, $this->ui->factory()->input()->field(), $this->refinery)->getInputs();
         $this->addField("title", $inputs[0]);
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addStdTitleAndDescription()

ILIAS\Repository\Form\addStdTitleAndDescription	(	int	$obj_id,
		string	$type
	)

Definition at line 36 of file trait.StdObjProperties.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Repository\$refinery, ILIAS\UI\Implementation\Component\Input\getInputs(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\edit(), ILIAS\Exercise\Settings\SettingsGUI\getEditForm(), ILIAS\SurveyQuestionPool\Settings\SettingsGUI\getEditForm(), ILIAS\Wiki\Settings\SettingsGUI\getEditForm(), and ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm().

      : FormAdapterGUI {
         $obj_prop = $this->object_prop->getFor($obj_id, $type);
         $inputs = $obj_prop
             ->getPropertyTitleAndDescription()
             ->toForm($this->lng, $this->ui->factory()->input()->field(), $this->refinery)->getInputs();
         $this->addField("title", $inputs[0]);
         $this->addField("description", $inputs[1]);
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildDidacticTemplateOptions()

ILIAS\Repository\Form\buildDidacticTemplateOptions	(	string	$type,
		int	$ref_id,
		array	$additional_template_options = `[]`
	)

private

Definition at line 306 of file trait.StdObjProperties.php.

References ilDidacticTemplateSettings\getInstanceByObjectType(), and ILIAS\Repository\lng().

Referenced by ILIAS\Repository\Form\addDidacticTemplates(), and ILIAS\Repository\Form\redirectToDidacticConfirmationIfChanged().

      : array {
         $this->lng->loadLanguageModule('didactic');
         $existing_exclusive = false;
         $options = [];
         $options['dtpl_0'] = [
             $this->lng->txt('didactic_default_type'),
             sprintf(
                 $this->lng->txt('didactic_default_type_info'),
                 $this->lng->txt('objs_' . $type)
             )
         ];
 
         $templates = \ilDidacticTemplateSettings::getInstanceByObjectType($type)->getTemplates();
         if ($templates) {
             foreach ($templates as $template) {
                 if ($template->isEffective((int) $ref_id)) {
                     $options["dtpl_" . $template->getId()] = [
                         $template->getPresentationTitle(),
                         $template->getPresentationDescription()
                     ];
 
                     if ($template->isExclusive()) {
                         $existing_exclusive = true;
                     }
                 }
             }
         }
 
         return [$existing_exclusive, array_merge($options, $additional_template_options)];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDidacticTemplateIdFromRequest()

ILIAS\Repository\Form\getDidacticTemplateIdFromRequest ( )

Definition at line 370 of file trait.StdObjProperties.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\http(), and ILIAS\Repository\refinery().

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\executeCommand().

                                                        : ?int
     {
         $new_tpl_id = null;
         if ($this->http->wrapper()->query()->has('didactic_template_id')) {
             $new_tpl_id = $this->http->wrapper()->query()->retrieve(
                 'didactic_template_id',
                 $this->refinery->kindlyTo()->int()
             );
             $this->ctrl->saveParameterByClass(\ilDidacticTemplateGUI::class, "didactic_template_id", $new_tpl_id);
         }
         return $new_tpl_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initStdObjProperties()

ILIAS\Repository\Form\initStdObjProperties ( Container $DIC )

protected

Definition at line 31 of file trait.StdObjProperties.php.

References ILIAS\Object\ilObjectDIC\dic().

Referenced by ILIAS\UI\Implementation\Component\Input\Container\Form\FormAdapterGUI\__construct().

     {
         $this->object_prop = ilObjectDIC::dic()['object_properties_agregator'];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redirectToDidacticConfirmationIfChanged()

ILIAS\Repository\Form\redirectToDidacticConfirmationIfChanged	(	int	$ref_id,
		string	$type,
		string	$gui_class,
		array	$additional_template_options = `[]`
	)

Definition at line 341 of file trait.StdObjProperties.php.

References ILIAS\Repository\Form\buildDidacticTemplateOptions(), ILIAS\Repository\ctrl(), ILIAS\Repository\int(), and ilDidacticTemplateObjSettings\lookupTemplateId().

      : void {
         list($existing_exclusive, $options) = $this->buildDidacticTemplateOptions(
             $type,
             $ref_id,
             $additional_template_options
         );
 
         if (sizeof($options) < 2) {
             return;
         }
 
         $current_tpl_id = \ilDidacticTemplateObjSettings::lookupTemplateId(
             $ref_id
         );
         $new_tpl_id = (int) substr($this->getData('didactic_type'), 5);
 
         if ($new_tpl_id !== $current_tpl_id) {
             // redirect to didactic template confirmation
             $this->ctrl->setParameterByClass(\ilDidacticTemplateGUI::class, "didactic_template_id", $new_tpl_id);
             $this->ctrl->redirectByClass([$gui_class, \ilDidacticTemplateGUI::class], "confirmTemplateSwitch");
             return;
         }
     }

Here is the call graph for this function:

◆ saveAdditionalFeatures()

ILIAS\Repository\Form\saveAdditionalFeatures	(	int	$obj_id,
		array	$services
	)

Definition at line 232 of file trait.StdObjProperties.php.

References ilContainer\_writeContainerSetting(), ilObjectServiceSettingsGUI\CUSTOM_METADATA, and ilObjectServiceSettingsGUI\TAXONOMIES.

      : void {
         // (local) custom metadata
         $key = \ilObjectServiceSettingsGUI::CUSTOM_METADATA;
         if (in_array($key, $services)) {
             \ilContainer::_writeContainerSetting($obj_id, $key, (string) $this->getData($key));
         }
         // taxonomies
         $key = \ilObjectServiceSettingsGUI::TAXONOMIES;
         if (in_array($key, $services)) {
             \ilContainer::_writeContainerSetting($obj_id, $key, (string) $this->getData($key));
         }
     }

Here is the call graph for this function:

◆ saveOnline()

ILIAS\Repository\Form\saveOnline	(	int	$obj_id,
		string	$type
	)

Definition at line 120 of file trait.StdObjProperties.php.

      : void {
         $obj_prop = $this->object_prop->getFor($obj_id, $type);
         $obj_prop->storePropertyIsOnline($this->getData("is_online"));
     }

◆ saveStdAvailability()

ILIAS\Repository\Form\saveStdAvailability ( int $ref_id )

Definition at line 163 of file trait.StdObjProperties.php.

References ilObjectActivation\TIMINGS_ACTIVATION, and ilObjectActivation\TIMINGS_DEACTIVATED.

                                                     : void
     {
         $item = new \ilObjectActivation();
         if (!$this->getData("limited")) {
             $item->setTimingType(\ilObjectActivation::TIMINGS_DEACTIVATED);
         } else {
             $avail = $this->getData("availability");
             $from = $to = null;
             if (!is_null($avail) && !is_null($avail[0])) {
                 $from = $avail[0]->getUnixTime();
             }
             if (!is_null($avail) && !is_null($avail[1])) {
                 $to = $avail[1]->getUnixTime();
             }
             if ($from > 0 || $to > 0) {
                 $item->setTimingType(\ilObjectActivation::TIMINGS_ACTIVATION);
                 $item->setTimingStart($from);
                 $item->setTimingEnd($to);
                 $item->toggleVisible($this->getData("visibility"));
             } else {
                 $item->setTimingType(\ilObjectActivation::TIMINGS_DEACTIVATED);
             }
         }
         $item->update($ref_id);
     }

◆ saveStdTile()

ILIAS\Repository\Form\saveStdTile	(	int	$obj_id,
		string	$type
	)

Definition at line 98 of file trait.StdObjProperties.php.

      : void {
         $obj_prop = $this->object_prop->getFor($obj_id, $type);
         $tile = $this->getData("tile");
         if (!is_null($tile)) {
             $obj_prop->storePropertyTileImage($this->getData("tile"));
         }
     }

◆ saveStdTitle()

ILIAS\Repository\Form\saveStdTitle	(	int	$obj_id,
		string	$type
	)

Definition at line 74 of file trait.StdObjProperties.php.

      : void {
         $obj_prop = $this->object_prop->getFor($obj_id, $type);
         $obj_prop->storePropertyTitleAndDescription(
             new \ilObjectPropertyTitleAndDescription(
                 $this->getData("title"),
                 ""
             )
         );
     }

◆ saveStdTitleAndDescription()

ILIAS\Repository\Form\saveStdTitleAndDescription	(	int	$obj_id,
		string	$type
	)

Definition at line 61 of file trait.StdObjProperties.php.

      : void {
         $obj_prop = $this->object_prop->getFor($obj_id, $type);
         $obj_prop->storePropertyTitleAndDescription(
             new \ilObjectPropertyTitleAndDescription(
                 $this->getData("title"),
                 $this->getData("description")
             )
         );
     }

Variable Documentation

◆ StdObjProperties

trait ILIAS::Repository::Form\StdObjProperties

Initial value:

{

protected \ilObjectPropertiesAgregator $object_prop

Definition at line 28 of file trait.StdObjProperties.php.

Functions

Variables

Function Documentation

◆ addAdditionalFeatures()

◆ addDidacticTemplates()

◆ addOnline()

◆ addStdAvailability()

◆ addStdTile()

◆ addStdTitle()

◆ addStdTitleAndDescription()

◆ buildDidacticTemplateOptions()

◆ getDidacticTemplateIdFromRequest()

◆ initStdObjProperties()

◆ redirectToDidacticConfirmationIfChanged()

◆ saveAdditionalFeatures()

◆ saveOnline()

◆ saveStdAvailability()

◆ saveStdTile()

◆ saveStdTitle()

◆ saveStdTitleAndDescription()

Variable Documentation

◆ StdObjProperties