ilObjectPropertyIcon Class Reference

Inheritance diagram for ilObjectPropertyIcon:

Collaboration diagram for ilObjectPropertyIcon:

Public Member Functions
	__construct (private bool $custom_icons_enabled, private ?ilObjectCustomIcon $custom_icon=null, private ?ilObjectTypeSpecificPropertyProviders $object_type_specific_property_providers=null)
	getObjectTypeSpecificIcon (int $object_id, IconFactory $factory, StorageService $irss)
	getCustomIcon ()
	getDeletedFlag ()
	withDeletedFlag ()
	getTempFileName ()
	withTempFileName (string $name)
	toForm (\ilLanguage $language, FieldFactory $field_factory, Refinery $refinery)
	toLegacyForm (\ilLanguage $language)
Public Member Functions inherited from ilObjectProperty
	toForm (ilLanguage $language, FieldFactory $field_factory, Refinery $refinery)

Data Fields
const	SUPPORTED_MIME_TYPES = [MimeType::IMAGE__SVG_XML]

Private Attributes
const	INPUT_LABEL = 'custom_icon'
bool	$deleted_flag = false
string	$temp_file_name = null

Detailed Description

Author

Stephan Kergomard

Definition at line 33 of file ilObjectPropertyIcon.php.

Constructor & Destructor Documentation

__construct()

ilObjectPropertyIcon::__construct	(	private bool	$custom_icons_enabled,
		private ?ilObjectCustomIcon	$custom_icon = null,
		private ?ilObjectTypeSpecificPropertyProviders	$object_type_specific_property_providers = null
	)

Definition at line 41 of file ilObjectPropertyIcon.php.

      {
    }

Member Function Documentation

getCustomIcon()

ilObjectPropertyIcon::getCustomIcon

(

)

Definition at line 59 of file ilObjectPropertyIcon.php.

References ILIAS\UI\examples\Symbol\Icon\Custom\custom_icon().

Referenced by ilObjectAdditionalPropertiesLegacyRepository\storeIcon().

                                   : ?ilObjectCustomIcon
    {
        return $this->custom_icons_enabled ? $this->custom_icon : null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDeletedFlag()

ilObjectPropertyIcon::getDeletedFlag

(

)

Definition at line 64 of file ilObjectPropertyIcon.php.

References $deleted_flag.

Referenced by ilObjectAdditionalPropertiesLegacyRepository\storeIcon().

                                    : bool
    {
        return $this->deleted_flag;
    }

Here is the caller graph for this function:

getObjectTypeSpecificIcon()

ilObjectPropertyIcon::getObjectTypeSpecificIcon	(	int	$object_id,
		IconFactory	$factory,
		StorageService	$irss
	)

Definition at line 48 of file ilObjectPropertyIcon.php.

     : ?CustomIcon {
        if ($this->object_type_specific_property_providers === null) {
            return null;
        }
        return $this->object_type_specific_property_providers->getObjectTypeSpecificIcon($object_id, $factory, $irss);
    }

getTempFileName()

ilObjectPropertyIcon::getTempFileName

(

)

Definition at line 76 of file ilObjectPropertyIcon.php.

References $temp_file_name.

Referenced by ilObjectAdditionalPropertiesLegacyRepository\storeIcon().

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

Here is the caller graph for this function:

toForm()

ilObjectPropertyIcon::toForm	(	\ilLanguage	$language,
		FieldFactory	$field_factory,
		Refinery	$refinery
	)

Definition at line 88 of file ilObjectPropertyIcon.php.

References ILIAS\UI\examples\Symbol\Icon\Custom\custom_icon(), ilLanguage\txt(), and ILIAS\UI\Component\Input\Input\withAdditionalTransformation().

     : ?File {
        if (!$this->custom_icons_enabled) {
            return null;
        }
        $trafo = $refinery->custom()->transformation(
            function ($v): ?ilObjectProperty {
                $property_icon = new ilObjectPropertyIcon(
                    $this->custom_icons_enabled,
                    $this->custom_icon
                );

                if (count($v) > 0 && $v[0] !== 'custom_icon') {
                    return $property_icon
                        ->withTempFileName($v[0]);
                }

                if (count($v) === 0 && $this->custom_icon->exists()) {
                    return $property_icon
                        ->withDeletedFlag();
                }

                return $property_icon;
            }
        );
        $custom_icon = $field_factory
            ->file(new ilObjectCustomIconUploadHandlerGUI($this->custom_icon), $language->txt(self::INPUT_LABEL))
            ->withAcceptedMimeTypes(self::SUPPORTED_MIME_TYPES)
            ->withAdditionalTransformation($trafo);

        if (!$this->custom_icon->exists()) {
            return $custom_icon;
        }

        return $custom_icon->withValue(['custom_icon']);
    }

Here is the call graph for this function:

toLegacyForm()

ilObjectPropertyIcon::toLegacyForm

(

\ilLanguage

$language

)

Definition at line 128 of file ilObjectPropertyIcon.php.

References ILIAS\UI\examples\Symbol\Icon\Custom\custom_icon(), ilFileInputGUI\setSuffixes(), and ilLanguage\txt().

     : ?ilImageFileInputGUI {
        if (!$this->custom_icons_enabled) {
            return null;
        }
        $custom_icon_input = new ilImageFileInputGUI($language->txt(self::INPUT_LABEL), 'icon');
        $custom_icon_input->setSuffixes($this->custom_icon->getSupportedFileExtensions());
        $custom_icon_input->setUseCache(false);
        if ($this->custom_icon->exists()) {
            $custom_icon_input->setImage($this->custom_icon->getFullPath());
        } else {
            $custom_icon_input->setImage('');
        }

        return $custom_icon_input;
    }

Here is the call graph for this function:

withDeletedFlag()

ilObjectPropertyIcon::withDeletedFlag

(

)

Definition at line 69 of file ilObjectPropertyIcon.php.

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

withTempFileName()

ilObjectPropertyIcon::withTempFileName

(

string

$name

)

Definition at line 81 of file ilObjectPropertyIcon.php.

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

Field Documentation

$deleted_flag

bool ilObjectPropertyIcon::$deleted_flag = false

private

Definition at line 38 of file ilObjectPropertyIcon.php.

Referenced by getDeletedFlag().

$temp_file_name

string ilObjectPropertyIcon::$temp_file_name = null

private

Definition at line 39 of file ilObjectPropertyIcon.php.

Referenced by getTempFileName().

INPUT_LABEL

const ilObjectPropertyIcon::INPUT_LABEL = 'custom_icon'

private

Definition at line 36 of file ilObjectPropertyIcon.php.

SUPPORTED_MIME_TYPES

const ilObjectPropertyIcon::SUPPORTED_MIME_TYPES = [MimeType::IMAGE__SVG_XML]

Definition at line 35 of file ilObjectPropertyIcon.php.

Referenced by ilObjectCustomIconUploadHandlerGUI\getUploadResult().

---

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

• components/ILIAS/ILIASObject/classes/Properties/AdditionalProperties/Icon/ilObjectPropertyIcon.php