ilObjectAdditionalPropertiesLegacyRepository Class Reference

Inheritance diagram for ilObjectAdditionalPropertiesLegacyRepository:

Collaboration diagram for ilObjectAdditionalPropertiesLegacyRepository:

Public Member Functions
	__construct (private ilObjectCustomIconFactory $custom_icon_factory, private ObjectTypeSpecificPropertiesFactory $object_type_specific_properties_factory)
	getFor (int $object_id)
	store (ilObjectAdditionalProperties $properties)

Private Member Functions
	getDefaultAdditionalProperties ()
	getTitleAndIconVisibility (int $object_id)
	storeTitleAndIconVisibility (int $object_id, bool $visibility)
	getHeaderActionVisibility (int $object_id)
	storeHeaderActionVisibility (int $object_id, bool $visibility)
	getInfoTabVisibility (int $object_id)
	storeInfoTabVisibility (int $object_id, bool $visibility)
	areCustomIconsEnabled ()
	storeIcon (ilObjectPropertyIcon $property_icon)

Detailed Description

Author

Stephan Kergomard

Definition at line 27 of file ilObjectAdditionalPropertiesLegacyRepository.php.

Constructor & Destructor Documentation

__construct()

ilObjectAdditionalPropertiesLegacyRepository::__construct	(	private ilObjectCustomIconFactory	$custom_icon_factory,
		private ObjectTypeSpecificPropertiesFactory	$object_type_specific_properties_factory
	)

Definition at line 29 of file ilObjectAdditionalPropertiesLegacyRepository.php.

      {
    }

Member Function Documentation

areCustomIconsEnabled()

ilObjectAdditionalPropertiesLegacyRepository::areCustomIconsEnabled ( )

private

Definition at line 154 of file ilObjectAdditionalPropertiesLegacyRepository.php.

References ilSetting\_lookupValue().

Referenced by getDefaultAdditionalProperties(), and getFor().

                                            : bool
    {
        return (bool) ilSetting::_lookupValue('common', 'custom_icons');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultAdditionalProperties()

ilObjectAdditionalPropertiesLegacyRepository::getDefaultAdditionalProperties ( )

private

Definition at line 97 of file ilObjectAdditionalPropertiesLegacyRepository.php.

References areCustomIconsEnabled().

Referenced by getFor().

                                                     : ilObjectAdditionalProperties
    {
        return new ilObjectAdditionalProperties(
            new ilObjectPropertyTitleAndIconVisibility(),
            new ilObjectPropertyHeaderActionVisibility(),
            new ilObjectPropertyInfoTabVisibility(),
            new ilObjectPropertyIcon(
                $this->areCustomIconsEnabled()
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFor()

ilObjectAdditionalPropertiesLegacyRepository::getFor

(

int

$object_id

)

Implements ilObjectAdditionalPropertiesRepository.

Definition at line 35 of file ilObjectAdditionalPropertiesLegacyRepository.php.

References ilObject\_lookupType(), areCustomIconsEnabled(), getDefaultAdditionalProperties(), getHeaderActionVisibility(), getInfoTabVisibility(), getTitleAndIconVisibility(), and null.

                                          : ilObjectAdditionalProperties
    {
        if ($object_id === 0) {
            return $this->getDefaultAdditionalProperties();
        }

        $type = ilObject::_lookupType($object_id);
        $object_type_specific_properties = $this->object_type_specific_properties_factory->getForObjectTypeString($type);
        $providers = null;
        if ($object_type_specific_properties !== null) {
            $providers = $object_type_specific_properties->getProviders();
        }

        return new ilObjectAdditionalProperties(
            new ilObjectPropertyTitleAndIconVisibility($this->getTitleAndIconVisibility($object_id)),
            new ilObjectPropertyHeaderActionVisibility($this->getHeaderActionVisibility($object_id)),
            new ilObjectPropertyInfoTabVisibility($this->getInfoTabVisibility($object_id)),
            new ilObjectPropertyIcon(
                $this->areCustomIconsEnabled(),
                $this->custom_icon_factory->getByObjId($object_id),
                $providers
            ),
            $object_id
        );
    }

Here is the call graph for this function:

getHeaderActionVisibility()

ilObjectAdditionalPropertiesLegacyRepository::getHeaderActionVisibility ( int  $object_id )

private

Definition at line 124 of file ilObjectAdditionalPropertiesLegacyRepository.php.

References ilContainer\_lookupContainerSetting().

Referenced by getFor().

                                                              : bool
    {
        return !((bool) ilContainer::_lookupContainerSetting($object_id, 'hide_top_actions'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInfoTabVisibility()

ilObjectAdditionalPropertiesLegacyRepository::getInfoTabVisibility ( int  $object_id )

private

Definition at line 139 of file ilObjectAdditionalPropertiesLegacyRepository.php.

References ilContainer\_lookupContainerSetting().

Referenced by getFor().

                                                         : bool
    {
        return ((bool) ilContainer::_lookupContainerSetting($object_id, 'cont_show_info_tab'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTitleAndIconVisibility()

ilObjectAdditionalPropertiesLegacyRepository::getTitleAndIconVisibility ( int  $object_id )

private

Definition at line 109 of file ilObjectAdditionalPropertiesLegacyRepository.php.

References ilContainer\_lookupContainerSetting().

Referenced by getFor().

                                                              : bool
    {
        return !((bool) ilContainer::_lookupContainerSetting($object_id, 'hide_header_icon_and_title'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

store()

ilObjectAdditionalPropertiesLegacyRepository::store

(

ilObjectAdditionalProperties

$properties

)

Implements ilObjectAdditionalPropertiesRepository.

Definition at line 61 of file ilObjectAdditionalPropertiesLegacyRepository.php.

References ilObjectAdditionalProperties\getObjectId(), ilObjectAdditionalProperties\getPropertyHeaderActionVisibility(), ilObjectAdditionalProperties\getPropertyIcon(), ilObjectAdditionalProperties\getPropertyInfoTabVisibility(), ilObjectAdditionalProperties\getPropertyTitleAndIconVisibility(), null, storeHeaderActionVisibility(), storeIcon(), storeInfoTabVisibility(), storeTitleAndIconVisibility(), ilObjectAdditionalProperties\wasPropertyHeaderActionVisbilityUpdated(), ilObjectAdditionalProperties\wasPropertyIconUpdated(), ilObjectAdditionalProperties\wasPropertyInfoTabVisbilityUpdated(), ilObjectAdditionalProperties\wasPropertyTitleAndIconVisibilityUpdated(), and ilObjectAdditionalProperties\withResetUpdatedFlags().

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

        $object_id = $properties->getObjectId();

        if ($properties->wasPropertyTitleAndIconVisibilityUpdated()) {
            $this->storeTitleAndIconVisibility(
                $object_id,
                $properties->getPropertyTitleAndIconVisibility()->getVisibility()
            );
        }

        if ($properties->wasPropertyHeaderActionVisbilityUpdated()) {
            $this->storeHeaderActionVisibility(
                $object_id,
                $properties->getPropertyHeaderActionVisibility()->getVisibility()
            );
        }

        if ($properties->wasPropertyInfoTabVisbilityUpdated()) {
            $this->storeInfoTabVisibility(
                $object_id,
                $properties->getPropertyInfoTabVisibility()->getVisibility()
            );
        }

        if ($properties->wasPropertyIconUpdated()) {
            $this->storeIcon($properties->getPropertyIcon());
        }

        return $properties->withResetUpdatedFlags();
    }

Here is the call graph for this function:

storeHeaderActionVisibility()

ilObjectAdditionalPropertiesLegacyRepository::storeHeaderActionVisibility ( int  $object_id, bool  $visibility  )

private

Definition at line 129 of file ilObjectAdditionalPropertiesLegacyRepository.php.

References ilContainer\_writeContainerSetting().

Referenced by store().

                                                                                  : void
    {
        $hide_top_actions = $visibility ? '' : '1';
        ilContainer::_writeContainerSetting(
            $object_id,
            'hide_top_actions',
            $hide_top_actions
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

storeIcon()

ilObjectAdditionalPropertiesLegacyRepository::storeIcon ( ilObjectPropertyIcon  $property_icon )

private

Definition at line 159 of file ilObjectAdditionalPropertiesLegacyRepository.php.

References ilObjectPropertyIcon\getCustomIcon(), ilObjectPropertyIcon\getDeletedFlag(), and ilObjectPropertyIcon\getTempFileName().

Referenced by store().

                                                                   : void
    {
        if ($property_icon->getDeletedFlag()) {
            $property_icon->getCustomIcon()->remove();
        }

        if ($property_icon->getTempFileName()) {
            $property_icon->getCustomIcon()->saveFromTempFileName($property_icon->getTempFileName());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

storeInfoTabVisibility()

ilObjectAdditionalPropertiesLegacyRepository::storeInfoTabVisibility ( int  $object_id, bool  $visibility  )

private

Definition at line 144 of file ilObjectAdditionalPropertiesLegacyRepository.php.

References ilContainer\_writeContainerSetting().

Referenced by store().

                                                                             : void
    {
        $show_info_tab = $visibility ? '1' : '';
        ilContainer::_writeContainerSetting(
            $object_id,
            'cont_show_info_tab',
            $show_info_tab
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

storeTitleAndIconVisibility()

ilObjectAdditionalPropertiesLegacyRepository::storeTitleAndIconVisibility ( int  $object_id, bool  $visibility  )

private

Definition at line 114 of file ilObjectAdditionalPropertiesLegacyRepository.php.

References ilContainer\_writeContainerSetting().

Referenced by store().

                                                                                  : void
    {
        $hide_header_icon_and_title = $visibility ? '' : '1';
        ilContainer::_writeContainerSetting(
            $object_id,
            'hide_header_icon_and_title',
            $hide_header_icon_and_title
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/ILIASObject/classes/Properties/AdditionalProperties/ilObjectAdditionalPropertiesLegacyRepository.php