ILIAS\ILIASObject\Properties\MultiPropertiesManipulator Class Reference

Collaboration diagram for ILIAS\ILIASObject\Properties\MultiPropertiesManipulator:

Public Member Functions
	__construct (private readonly ObjectReferencePropertiesRepository $object_reference_properties_repo, private readonly Aggregator $properties_agregator, private readonly \ilLanguage $language, private readonly \ilCtrlInterface $ctrl, private readonly \ilObjUser $user, private readonly UIFactory $ui_factory, private readonly \ilGlobalTemplateInterface $tpl, private readonly Refinery $refinery)
	getAvailabilityPeriodButton ()
	getEditAvailabilityPeriodPropertiesModal (array $ref_ids, \ilObjectGUI $parent_gui)
	saveEditAvailabilityPeriodPropertiesModal (\ilObjectGUI $parent_gui, \Closure $check_access, ServerRequestInterface $request)

Private Member Functions
	buildModal (string $post_url, ?array $items=null, ?array $ref_ids=null, bool $all_settings_are_equal=false)
	buildForm (?int $ref_id_for_values)
	saveAvailabilityPeriodPropertyForObjectRefIds (array $object_reference_ids, AvailabilityPeriod $property)
	areAllElementsEqual (array $ref_ids)
	getItemsForRefIds (array $object_reference_ids)

Detailed Description

Definition at line 32 of file MultiPropertiesManipulator.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ILIASObject\Properties\MultiPropertiesManipulator::__construct	(	private readonly ObjectReferencePropertiesRepository	$object_reference_properties_repo,
		private readonly Aggregator	$properties_agregator,
		private readonly \ilLanguage	$language,
		private readonly \ilCtrlInterface	$ctrl,
		private readonly \ilObjUser	$user,
		private readonly UIFactory	$ui_factory,
		private readonly \ilGlobalTemplateInterface	$tpl,
		private readonly Refinery	$refinery
	)

Definition at line 34 of file MultiPropertiesManipulator.php.

      {
    }

Member Function Documentation

areAllElementsEqual()

ILIAS\ILIASObject\Properties\MultiPropertiesManipulator::areAllElementsEqual ( array  $ref_ids )

private

Parameters

array<int>

$ref_ids

Definition at line 174 of file MultiPropertiesManipulator.php.

                                                        : bool
    {
        $previous_element = $this->object_reference_properties_repo->getFor(array_shift($ref_ids))->getPropertyAvailabilityPeriod();
        foreach ($ref_ids as $ref_id) {
            $current_element = $this->object_reference_properties_repo->getFor($ref_id)->getPropertyAvailabilityPeriod();
            if ($current_element->getAvailabilityPeriodEnabled() === false
                && $previous_element->getAvailabilityPeriodEnabled() === false) {
                return true;
            }
 
            if ($current_element->getAvailabilityPeriodEnabled() !== $previous_element->getAvailabilityPeriodEnabled()
                || $current_element->getAvailabilityPeriodStart() != $previous_element->getAvailabilityPeriodStart()
                || $current_element->getAvailabilityPeriodEnd() != $previous_element->getAvailabilityPeriodEnd()
                || $current_element->getVisibleWhenDisabled() !== $previous_element->getVisibleWhenDisabled()) {
                return false;
            }
        }
        return true;
    }

References $ref_id.

buildForm()

ILIAS\ILIASObject\Properties\MultiPropertiesManipulator::buildForm ( ?int  $ref_id_for_values )

private

Returns

array<ILIAS\UI\Component\Input\Input>

Definition at line 138 of file MultiPropertiesManipulator.php.

                                                       : array
    {
        $data_factory = new DataFactory();
        $date_format = $this->user->getDateFormat();
        $environment = [
            'user_time_zone' => $this->user->getTimeZone(),
            'user_date_format' => $data_factory->dateFormat()->withTime24($date_format)
        ];
 
        $input_fields = [];
        $input_fields['enable_availability_period'] = $this->object_reference_properties_repo
            ->getFor($ref_id_for_values)->getPropertyAvailabilityPeriod()->toForm(
                $this->language,
                $this->ui_factory->input()->field(),
                $this->refinery,
                $environment
            );
        $input_fields['affected_items'] = $this->ui_factory->input()->field()->hidden();
 
        return $input_fields;
    }

References ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Repository\user().

Here is the call graph for this function:

buildModal()

ILIAS\ILIASObject\Properties\MultiPropertiesManipulator::buildModal ( string  $post_url, ?array  $items = null, ?array  $ref_ids = null, bool  $all_settings_are_equal = false  )

private

Definition at line 106 of file MultiPropertiesManipulator.php.

     : RoundTripModal {
        $ref_id_for_value = null;
 
        if ($ref_ids !== null && $all_settings_are_equal) {
            $ref_id_for_value = $ref_ids[0];
        }
        $modal_factory = $this->ui_factory->modal();
        $content = $items;
 
        $input_fields = $this->buildForm($ref_id_for_value);
 
        if ($ref_ids !== null) {
            $input_fields['affected_items'] = $input_fields['affected_items']->withValue(implode(',', $ref_ids));
        }
 
        if ($ref_ids !== null && !$all_settings_are_equal) {
            $content = [
                $this->ui_factory->messageBox()->info($this->language->txt('unequal_items_for_availability_period_message')),
            ] + $items;
        }
        return $modal_factory->roundtrip($this->language->txt('edit_availability_period'), $content, $input_fields, $post_url);
    }

getAvailabilityPeriodButton()

ILIAS\ILIASObject\Properties\MultiPropertiesManipulator::getAvailabilityPeriodButton

(

)

Definition at line 46 of file MultiPropertiesManipulator.php.

                                                 : StandardButton
    {
        $on_load_code = function ($id) {
            return "document.getElementById('$id')"
                . '.addEventListener("click", '
                . '(e) => {e.preventDefault();'
                . 'e.target.setAttribute("name", "cmd[editAvailabilityPeriod]");'
                . 'e.target.form.requestSubmit(e.target);});';
        };
 
        return $this->ui_factory->button()->standard(
            $this->language->txt('edit_availability_period'),
            ''
        )->withAdditionalOnLoadCode($on_load_code);
    }

References $id, ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\UI\Implementation\Component\withAdditionalOnLoadCode().

Here is the call graph for this function:

getEditAvailabilityPeriodPropertiesModal()

ILIAS\ILIASObject\Properties\MultiPropertiesManipulator::getEditAvailabilityPeriodPropertiesModal	(	array	$ref_ids,
		\ilObjectGUI	$parent_gui
	)

Definition at line 62 of file MultiPropertiesManipulator.php.

     : ?RoundTripModal {
        if ($ref_ids === []) {
            $this->tpl->setOnScreenMessage('failure', $this->language->txt('no_objects_selected'));
            return null;
        }
 
        $this->object_reference_properties_repo->preload($ref_ids);
        $this->properties_agregator->preload($ref_ids);
 
        $items = $this->getItemsForRefIds($ref_ids);
 
        $post_url = $this->ctrl->getFormAction($parent_gui, 'saveAvailabilityPeriod');
 
        return $this->buildModal($post_url, $items, $ref_ids, $this->areAllElementsEqual($ref_ids));
    }

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

getItemsForRefIds()

ILIAS\ILIASObject\Properties\MultiPropertiesManipulator::getItemsForRefIds ( array  $object_reference_ids )

private

Parameters

array<int>

$ref_ids

Returns

array<ILIAS\UI\Component\Item\Shy>

Definition at line 198 of file MultiPropertiesManipulator.php.

                                                                   : array
    {
        $items = [];
        foreach ($object_reference_ids as $object_reference_id) {
            $object_id = $this->object_reference_properties_repo->getFor(
                $object_reference_id
            )->getObjectId();
            $object_properties = $this->properties_agregator->getFor(
                $object_id
            );
            $title = $object_properties->getPropertyTitleAndDescription()->getTitle();
            $icon = $this->ui_factory->symbol()->icon()->custom(
                \ilObject::getIconForReference($object_reference_id, $object_id, ''),
                $title
            );
            $key = 'obj_' . $object_reference_id;
            $items[$key] = $this->ui_factory->item()->shy($title)->withLeadIcon($icon);
        }
        return $items;
    }

saveAvailabilityPeriodPropertyForObjectRefIds()

ILIAS\ILIASObject\Properties\MultiPropertiesManipulator::saveAvailabilityPeriodPropertyForObjectRefIds ( array  $object_reference_ids, AvailabilityPeriod  $property  )

private

Definition at line 160 of file MultiPropertiesManipulator.php.

     : void {
        foreach ($object_reference_ids as $object_reference_id) {
            $this->object_reference_properties_repo->storePropertyAvailabilityPeriod(
                $property->withObjectReferenceId($object_reference_id)
            );
        }
    }

References ILIAS\ILIASObject\Properties\ObjectReferenceProperties\AvailabilityPeriod\AvailabilityPeriod\withObjectReferenceId().

Here is the call graph for this function:

saveEditAvailabilityPeriodPropertiesModal()

ILIAS\ILIASObject\Properties\MultiPropertiesManipulator::saveEditAvailabilityPeriodPropertiesModal	(	\ilObjectGUI	$parent_gui,
		\Closure	$check_access,
		ServerRequestInterface	$request
	)

Definition at line 81 of file MultiPropertiesManipulator.php.

     : RoundTripModal|bool {
        $post_url = $this->ctrl->getFormAction($parent_gui, 'saveAvailabilityPeriod');
        $availability_period_modal = $this->buildModal($post_url)
            ->withRequest($request);
        $data = $availability_period_modal->getData();
        if ($data === null) {
            return $availability_period_modal;
        }
        $ref_ids = $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())->transform(
            explode(',', $data['affected_items'])
        );
 
        if (!$check_access($ref_ids)) {
            return false;
        }
 
        $availability_period_property = $data['enable_availability_period'];
        $this->saveAvailabilityPeriodPropertyForObjectRefIds($ref_ids, $availability_period_property);
        return true;
    }

---

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

• components/ILIAS/ILIASObject/src/Properties/MultiPropertiesManipulator.php