Inheritance diagram for ilMMAbstractItemFacade:

Collaboration diagram for ilMMAbstractItemFacade:

Public Member Functions
	__construct (protected IdentificationInterface $identification, Main $collector)
	ilMMAbstractItemFacade constructor. More...

	getId ()

	hasStorage ()

	supportsRoleBasedVisibility ()
	@inheritDoc More...

	canBeDeactivated ()

	hasRoleBasedVisibility ()
	@inheritDoc More...

	setRoleBasedVisibility (bool $role_based_visibility)
	@inheritDoc More...

	getGlobalRoleIDs ()
	@inheritDoc More...

	setGlobalRoleIDs (array $global_role_ids)
	@inheritDoc More...

	isEmpty ()

	itemStorage ()

	identification ()

	getRawItem ()

	getFilteredItem ()

	getAmountOfChildren ()

	isAvailable ()

	isActivated ()
	@inheritDoc More...

	isAlwaysAvailable ()
	@inheritDoc More...

	getProviderNameForPresentation ()

	getDefaultTitle ()

	setDefaultTitle (string $default_title)

	getStatus ()

	getTypeForPresentation ()

	getParentIdentificationString ()

	isCustomType ()

	isTopItem ()
	@inheritDoc More...

	canHaveChildren ()

	isChild ()

	isInLostItem ()
	@inheritDoc More...

	setIsTopItm (bool $top_item)
	@inheritDoc More...

	isInterchangeable ()
	@inheritDoc More...

	getType ()
	FSX check if doublette @inheritDoc. More...

	setParent (string $parent)

	setPosition (int $position)

	setActiveStatus (bool $status)

	supportsCustomIcon ()

	getIconID ()

	setIconID (string $icon_id)
	@inheritDoc More...

	update ()

	create ()

	getTitle ()

	delete ()
	@inheritDoc More...

Public Member Functions inherited from ilMMItemFacadeInterface
	itemStorage ()

	getRawItem ()

	getFilteredItem ()

	identification ()

	getTypeForPresentation ()

	getProviderNameForPresentation ()

	getStatus ()

	isAvailable ()

	isActivated ()

	canBeDeactivated ()

	isEditable ()

	isDeletable ()

	isAlwaysAvailable ()

	getDefaultTitle ()

	getId ()

	getAmountOfChildren ()

	hasStorage ()

	supportsRoleBasedVisibility ()

	hasRoleBasedVisibility ()

	getGlobalRoleIDs ()

	setGlobalRoleIDs (array $global_role_ids)

	setRoleBasedVisibility (bool $role_based_visibility)

	isEmpty ()

	isCustom ()

	supportsCustomIcon ()

	isCustomType ()

	getParentIdentificationString ()

	getType ()

	isTopItem ()

	canHaveChildren ()

	isChild ()

	isInLostItem ()

	getIconID ()

	setAction (string $action)

	setActiveStatus (bool $status)

	setDefaultTitle (string $default_title)

	setIconID (string $icon_id)

	setPosition (int $position)

	setParent (string $parent)

	setType (string $type)

	setIsTopItm (bool $top_item)

	isInterchangeable ()

	update ()

	create ()

	delete ()

	getId ()

	getTitle ()

Protected Member Functions
	deleteAssociatedTranslations ()
	deletes all translations associated with the current identification. More...

Protected Attributes
bool	$role_based_visibility = false

array	$global_role_ids = []

TypeInformation	$type_information

ilMMItemStorage	$mm_item

isItem	$filtered_item

isItem	$raw_item

string	$default_title = "-"

Detailed Description

Class ilMMAbstractItemFacade.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 46 of file class.ilMMAbstractItemFacade.php.

Constructor & Destructor Documentation

◆ __construct()

ilMMAbstractItemFacade::__construct	(	protected IdentificationInterface	$identification,
		Main	$collector
	)

ilMMAbstractItemFacade constructor.

Exceptions

Throwable

Definition at line 63 of file class.ilMMAbstractItemFacade.php.

      {
        $this->raw_item = $collector->getSingleItemFromRaw($this->identification);
        $this->filtered_item = $collector->getSingleItemFromFilter($this->identification);
        $this->type_information = $collector->getTypeInformationCollection()->get($this->raw_item::class);
        $this->mm_item = ilMMItemStorage::register($this->raw_item);
    }

References identification(), and ilMMItemStorage\register().

Here is the call graph for this function:

Member Function Documentation

◆ canBeDeactivated()

ilMMAbstractItemFacade::canBeDeactivated ( )

Implements ilMMItemFacadeInterface.

Definition at line 91 of file class.ilMMAbstractItemFacade.php.

                                      : bool
    {
        return !$this->raw_item->isAlwaysAvailable();
    }

◆ canHaveChildren()

ilMMAbstractItemFacade::canHaveChildren ( )

Implements ilMMItemFacadeInterface.

Definition at line 271 of file class.ilMMAbstractItemFacade.php.

                                     : bool
    {
        return $this->raw_item instanceof isParent;
    }

◆ create()

ilMMAbstractItemFacade::create ( )

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMNullItemFacade.

Definition at line 364 of file class.ilMMAbstractItemFacade.php.

                            : void
    {
        ilMMItemTranslationStorage::storeDefaultTranslation($this->identification, $this->default_title);
        $this->mm_item->create();
        ilMMItemStorage::register($this->raw_item);
    }

References identification(), ilMMItemStorage\register(), and ilMMItemTranslationStorage\storeDefaultTranslation().

Here is the call graph for this function:

◆ delete()

ilMMAbstractItemFacade::delete ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade.

Definition at line 396 of file class.ilMMAbstractItemFacade.php.

                            : void
    {
        if ($this->isDeletable()) {
            $this->deleteAssociatedTranslations();
            $serialize = $this->identification->serialize();
            $mm = ilMMItemStorage::find($serialize);
            if ($mm instanceof ilMMItemStorage) {
                $mm->delete();
            }
        }
    }

References deleteAssociatedTranslations(), identification(), and ilMMItemFacadeInterface\isDeletable().

Here is the call graph for this function:

◆ deleteAssociatedTranslations()

ilMMAbstractItemFacade::deleteAssociatedTranslations ( )

protected

deletes all translations associated with the current identification.

Exceptions

Exception

Definition at line 375 of file class.ilMMAbstractItemFacade.php.

                                                     : void
    {
        $ts = ilMMItemTranslationStorage::where([
            'identification' => $this->identification->serialize(),
        ], '=')->get();
 
        foreach ($ts as $translation) {
            if ($translation instanceof ilMMItemTranslationStorage) {
                $translation->delete();
            }
        }
    }

References identification(), and ActiveRecord\where().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAmountOfChildren()

ilMMAbstractItemFacade::getAmountOfChildren ( )

Implements ilMMItemFacadeInterface.

Definition at line 152 of file class.ilMMAbstractItemFacade.php.

                                         : int
    {
        if ($this->filtered_item instanceof isParent || $this->filtered_item instanceof isTopItem) {
            return $this->filtered_item->getAmountOfChildren();
        }
 
        return 0;
    }

◆ getDefaultTitle()

ilMMAbstractItemFacade::getDefaultTitle ( )

Implements ilMMItemFacadeInterface.

Definition at line 193 of file class.ilMMAbstractItemFacade.php.

                                     : string
    {
        $default_translation = ilMMItemTranslationStorage::getDefaultTranslation($this->identification);
        if ($default_translation !== "") {
            return $default_translation;
        }
        if ($this->default_title === "-" && $this->raw_item instanceof hasTitle) {
            $this->default_title = $this->raw_item->getTitle();
        }
 
        return $this->default_title;
    }

References $default_title, and identification().

Referenced by getTitle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFilteredItem()

ilMMAbstractItemFacade::getFilteredItem ( )

Implements ilMMItemFacadeInterface.

Definition at line 147 of file class.ilMMAbstractItemFacade.php.

                                     : isItem
    {
        return $this->filtered_item;
    }

References $filtered_item.

Referenced by getParentIdentificationString(), and isChild().

Here is the caller graph for this function:

◆ getGlobalRoleIDs()

ilMMAbstractItemFacade::getGlobalRoleIDs ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

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

                                      : array
    {
        return $this->global_role_ids;
    }

References $global_role_ids.

◆ getIconID()

ilMMAbstractItemFacade::getIconID ( )

Implements ilMMItemFacadeInterface.

Definition at line 343 of file class.ilMMAbstractItemFacade.php.

                               : ?string
    {
        return $this->mm_item->getIconId();
    }

◆ getId()

ilMMAbstractItemFacade::getId ( )

Implements ilMMItemFacadeInterface.

Definition at line 73 of file class.ilMMAbstractItemFacade.php.

                           : string
    {
        return $this->identification->serialize();
    }

References identification().

Referenced by hasStorage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParentIdentificationString()

ilMMAbstractItemFacade::getParentIdentificationString ( )

Implements ilMMItemFacadeInterface.

Definition at line 232 of file class.ilMMAbstractItemFacade.php.

                                                   : string
    {
        if ($this->getFilteredItem() instanceof isChild || $this->getFilteredItem() instanceof isInterchangeableItem) {
            $provider_name_for_presentation = $this->raw_item->getParent()->serialize();
 
            $storage_parent = $this->mm_item->getParentIdentification();
            if ($storage_parent !== $provider_name_for_presentation) {
                return $storage_parent;
            }
 
            return $provider_name_for_presentation;
        }
 
        return "";
    }

References getFilteredItem().

Here is the call graph for this function:

◆ getProviderNameForPresentation()

ilMMAbstractItemFacade::getProviderNameForPresentation ( )

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade, and ilMMNullItemFacade.

Definition at line 188 of file class.ilMMAbstractItemFacade.php.

                                                    : string
    {
        return $this->identification->getProviderNameForPresentation();
    }

References identification().

Here is the call graph for this function:

◆ getRawItem()

ilMMAbstractItemFacade::getRawItem ( )

Implements ilMMItemFacadeInterface.

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

                                : isItem
    {
        return $this->raw_item;
    }

References $raw_item.

Referenced by isActivated(), and isAlwaysAvailable().

Here is the caller graph for this function:

◆ getStatus()

ilMMAbstractItemFacade::getStatus ( )

Implements ilMMItemFacadeInterface.

Definition at line 211 of file class.ilMMAbstractItemFacade.php.

                               : ?Content
    {
        $non_available_reason = $this->raw_item->getNonAvailableReason();
        if (!$this->raw_item->isAvailable()) {
            return $non_available_reason;
        }
        if ($this->raw_item->isAlwaysAvailable()) {
            return $non_available_reason;
        }
 
        return null;
    }

◆ getTitle()

ilMMAbstractItemFacade::getTitle ( )

Implements ILIAS\GlobalScreen\GUI\I18n\MultiLanguage\TranslatableItem.

Definition at line 388 of file class.ilMMAbstractItemFacade.php.

                              : string
    {
        return $this->getDefaultTitle();
    }

References getDefaultTitle().

Here is the call graph for this function:

◆ getType()

ilMMAbstractItemFacade::getType ( )

FSX check if doublette @inheritDoc.

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade.

Definition at line 315 of file class.ilMMAbstractItemFacade.php.

                             : string
    {
        return $this->type_information->getType();
    }

◆ getTypeForPresentation()

ilMMAbstractItemFacade::getTypeForPresentation ( )

Exceptions

ReflectionException

Implements ilMMItemFacadeInterface.

Definition at line 227 of file class.ilMMAbstractItemFacade.php.

                                            : string
    {
        return $this->type_information->getTypeNameForPresentation();
    }

◆ hasRoleBasedVisibility()

ilMMAbstractItemFacade::hasRoleBasedVisibility ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

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

                                            : bool
    {
        return $this->role_based_visibility;
    }

References $role_based_visibility.

◆ hasStorage()

ilMMAbstractItemFacade::hasStorage ( )

Implements ilMMItemFacadeInterface.

Definition at line 78 of file class.ilMMAbstractItemFacade.php.

                                : bool
    {
        return ilMMItemStorage::find($this->getId()) !== null;
    }

References getId().

Here is the call graph for this function:

◆ identification()

ilMMAbstractItemFacade::identification ( )

Implements ilMMItemFacadeInterface.

Definition at line 138 of file class.ilMMAbstractItemFacade.php.

                                    : IdentificationInterface
    {
        return $this->identification;
    }

Referenced by __construct(), create(), delete(), deleteAssociatedTranslations(), getDefaultTitle(), getId(), getProviderNameForPresentation(), update(), and ilMMCustomItemFacade\update().

Here is the caller graph for this function:

◆ isActivated()

ilMMAbstractItemFacade::isActivated ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

Definition at line 172 of file class.ilMMAbstractItemFacade.php.

                                 : bool
    {
        if ($this->mm_item->isActive() && $this->getRawItem()->isAvailable()) {
            return true;
        }
        return $this->getRawItem()->isAlwaysAvailable();
    }

References getRawItem().

Here is the call graph for this function:

◆ isAlwaysAvailable()

ilMMAbstractItemFacade::isAlwaysAvailable ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMNullItemFacade.

Definition at line 183 of file class.ilMMAbstractItemFacade.php.

                                       : bool
    {
        return $this->getRawItem()->isAlwaysAvailable();
    }

References getRawItem().

Here is the call graph for this function:

◆ isAvailable()

ilMMAbstractItemFacade::isAvailable ( )

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMNullItemFacade.

Definition at line 161 of file class.ilMMAbstractItemFacade.php.

                                 : bool
    {
        if ($this->filtered_item->isAvailable()) {
            return true;
        }
        return $this->filtered_item->isAlwaysAvailable();
    }

◆ isChild()

ilMMAbstractItemFacade::isChild ( )

Implements ilMMItemFacadeInterface.

Definition at line 276 of file class.ilMMAbstractItemFacade.php.

                             : bool
    {
        $item = $this->getFilteredItem();
        return $item instanceof isChild
            || ($item instanceof isInterchangeableItem && $item->hasChanged());
    }

References getFilteredItem(), and ILIAS\GlobalScreen\Scope\MainMenu\Factory\isInterchangeableItem\hasChanged().

Here is the call graph for this function:

◆ isCustomType()

ilMMAbstractItemFacade::isCustomType ( )

Implements ilMMItemFacadeInterface.

Definition at line 248 of file class.ilMMAbstractItemFacade.php.

                                  : bool
    {
        $known_core_types = [
            Complex::class,
            Link::class,
            LinkList::class,
            Lost::class,
            RepositoryLink::class,
            Separator::class,
            TopLinkItem::class,
            TopParentItem::class,
        ];
        return !in_array($this->raw_item::class, $known_core_types, true);
    }

◆ isEmpty()

ilMMAbstractItemFacade::isEmpty ( )

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMNullItemFacade.

Definition at line 128 of file class.ilMMAbstractItemFacade.php.

                             : bool
    {
        return $this->mm_item->getIdentification() === '';
    }

◆ isInLostItem()

ilMMAbstractItemFacade::isInLostItem ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

Definition at line 286 of file class.ilMMAbstractItemFacade.php.

                                  : bool
    {
        if ($this->raw_item instanceof isChild) {
            return $this->raw_item->getParent() instanceof NullIdentification;
        }
 
        return false;
    }

◆ isInterchangeable()

ilMMAbstractItemFacade::isInterchangeable ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

Definition at line 306 of file class.ilMMAbstractItemFacade.php.

                                       : bool
    {
        return $this->raw_item instanceof isInterchangeableItem;
    }

◆ isTopItem()

ilMMAbstractItemFacade::isTopItem ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade, and ilMMNullItemFacade.

Definition at line 266 of file class.ilMMAbstractItemFacade.php.

                               : bool
    {
        return $this->raw_item instanceof isTopItem;
    }

References isTopItem().

Referenced by isTopItem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ itemStorage()

ilMMAbstractItemFacade::itemStorage ( )

Implements ilMMItemFacadeInterface.

Definition at line 133 of file class.ilMMAbstractItemFacade.php.

                                 : ilMMItemStorage
    {
        return $this->mm_item;
    }

References $mm_item.

◆ setActiveStatus()

ilMMAbstractItemFacade::setActiveStatus ( bool $status )

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMNullItemFacade.

Definition at line 333 of file class.ilMMAbstractItemFacade.php.

                                                 : void
    {
        $this->mm_item->setActive($status);
    }

◆ setDefaultTitle()

ilMMAbstractItemFacade::setDefaultTitle ( string $default_title )

Implements ilMMItemFacadeInterface.

Definition at line 206 of file class.ilMMAbstractItemFacade.php.

                                                          : void
    {
        $this->default_title = $default_title;
    }

References $default_title.

◆ setGlobalRoleIDs()

ilMMAbstractItemFacade::setGlobalRoleIDs ( array $global_role_ids )

@inheritDoc

Implements ilMMItemFacadeInterface.

Definition at line 123 of file class.ilMMAbstractItemFacade.php.

                                                            : void
    {
        $this->global_role_ids = $global_role_ids;
    }

References $global_role_ids.

◆ setIconID()

ilMMAbstractItemFacade::setIconID ( string $icon_id )

@inheritDoc

Implements ilMMItemFacadeInterface.

Definition at line 351 of file class.ilMMAbstractItemFacade.php.

                                              : void
    {
        $this->mm_item->setIconId($icon_id);
    }

◆ setIsTopItm()

ilMMAbstractItemFacade::setIsTopItm ( bool $top_item )

@inheritDoc

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade, and ilMMNullItemFacade.

Definition at line 298 of file class.ilMMAbstractItemFacade.php.

                                               : void
    {
        // TODO: Implement setIsTopItm() method.
    }

◆ setParent()

ilMMAbstractItemFacade::setParent ( string $parent )

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMNullItemFacade.

Definition at line 320 of file class.ilMMAbstractItemFacade.php.

                                             : void
    {
        $this->mm_item->setParentIdentification($parent);
    }

◆ setPosition()

ilMMAbstractItemFacade::setPosition ( int $position )

Implements ilMMItemFacadeInterface.

Definition at line 328 of file class.ilMMAbstractItemFacade.php.

                                              : void
    {
        $this->mm_item->setPosition($position);
    }

◆ setRoleBasedVisibility()

ilMMAbstractItemFacade::setRoleBasedVisibility ( bool $role_based_visibility )

@inheritDoc

Implements ilMMItemFacadeInterface.

Definition at line 107 of file class.ilMMAbstractItemFacade.php.

                                                                       : void
    {
        $this->role_based_visibility = $role_based_visibility;
    }

References $role_based_visibility.

◆ supportsCustomIcon()

ilMMAbstractItemFacade::supportsCustomIcon ( )

Implements ilMMItemFacadeInterface.

Definition at line 338 of file class.ilMMAbstractItemFacade.php.

                                        : bool
    {
        return $this->raw_item instanceof hasSymbol;
    }

References ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasSymbol().

Here is the call graph for this function:

◆ supportsRoleBasedVisibility()

ilMMAbstractItemFacade::supportsRoleBasedVisibility ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade, and ilMMNullItemFacade.

Definition at line 86 of file class.ilMMAbstractItemFacade.php.

                                                 : bool
    {
        return false;
    }

◆ update()

ilMMAbstractItemFacade::update ( )

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade.

Definition at line 358 of file class.ilMMAbstractItemFacade.php.

                            : void
    {
        ilMMItemTranslationStorage::storeDefaultTranslation($this->identification, $this->default_title);
        $this->mm_item->update();
    }

References identification(), and ilMMItemTranslationStorage\storeDefaultTranslation().

Here is the call graph for this function:

Field Documentation

◆ $default_title

string ilMMAbstractItemFacade::$default_title = "-"

protected

Definition at line 57 of file class.ilMMAbstractItemFacade.php.

Referenced by getDefaultTitle(), and setDefaultTitle().

◆ $filtered_item

isItem ilMMAbstractItemFacade::$filtered_item

protected

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

Referenced by getFilteredItem().

◆ $global_role_ids

array ilMMAbstractItemFacade::$global_role_ids = []

protected

Definition at line 50 of file class.ilMMAbstractItemFacade.php.

Referenced by getGlobalRoleIDs(), and setGlobalRoleIDs().

◆ $mm_item

ilMMItemStorage ilMMAbstractItemFacade::$mm_item

protected

Definition at line 54 of file class.ilMMAbstractItemFacade.php.

Referenced by itemStorage().

◆ $raw_item

isItem ilMMAbstractItemFacade::$raw_item

protected

Definition at line 56 of file class.ilMMAbstractItemFacade.php.

Referenced by getRawItem().

◆ $role_based_visibility

bool ilMMAbstractItemFacade::$role_based_visibility = false

protected

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

Referenced by hasRoleBasedVisibility(), and setRoleBasedVisibility().

◆ $type_information

TypeInformation ilMMAbstractItemFacade::$type_information

protected

Definition at line 52 of file class.ilMMAbstractItemFacade.php.

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

components/ILIAS/MainMenu/classes/Items/Facade/class.ilMMAbstractItemFacade.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canBeDeactivated()

◆ canHaveChildren()

◆ create()

◆ delete()

◆ deleteAssociatedTranslations()

◆ getAmountOfChildren()

◆ getDefaultTitle()

◆ getFilteredItem()

◆ getGlobalRoleIDs()

◆ getIconID()

◆ getId()

◆ getParentIdentificationString()

◆ getProviderNameForPresentation()

◆ getRawItem()

◆ getStatus()

◆ getTitle()

◆ getType()

◆ getTypeForPresentation()

◆ hasRoleBasedVisibility()

◆ hasStorage()

◆ identification()

◆ isActivated()

◆ isAlwaysAvailable()

◆ isAvailable()

◆ isChild()

◆ isCustomType()

◆ isEmpty()

◆ isInLostItem()

◆ isInterchangeable()

◆ isTopItem()

◆ itemStorage()

◆ setActiveStatus()

◆ setDefaultTitle()

◆ setGlobalRoleIDs()

◆ setIconID()

◆ setIsTopItm()

◆ setParent()

◆ setPosition()

◆ setRoleBasedVisibility()

◆ supportsCustomIcon()

◆ supportsRoleBasedVisibility()

◆ update()

Field Documentation

◆ $default_title

◆ $filtered_item

◆ $global_role_ids

◆ $mm_item

◆ $raw_item

◆ $role_based_visibility

◆ $type_information