Class ilMMAbstractItemFacade. More...

Inheritance diagram for ilMMAbstractItemFacade:

Collaboration diagram for ilMMAbstractItemFacade:

Public Member Functions

__construct (IdentificationInterface $identification, Main $collector)

ilMMAbstractItemFacade constructor. More...

getId ()

hasStorage ()

supportsRoleBasedVisibility ()

@inheritDoc More...

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...

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)

Parameters

int $position

More...

setActiveStatus (bool $status)

supportsCustomIcon ()

getIconID ()

setIconID (string $icon_id)

@inheritDoc More...

update ()

create ()

delete ()

@inheritDoc More...

Public Member Functions inherited from ilMMItemFacadeInterface

itemStorage ()

getRawItem ()

getFilteredItem ()

identification ()

getTypeForPresentation ()

getProviderNameForPresentation ()

getStatus ()

isAvailable ()

isActivated ()

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 ()

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 ()

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

IdentificationInterface	$identification

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 29 of file class.ilMMAbstractItemFacade.php.

Constructor & Destructor Documentation

◆ __construct()

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

ilMMAbstractItemFacade constructor.

Parameters

IdentificationInterface	$identification
Main	$collector

Exceptions

Throwable

Reimplemented in ilMMCustomItemFacade, ilMMItemFacade, and ilMMNullItemFacade.

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ create()

ilMMAbstractItemFacade::create ( )

Returns: void

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMNullItemFacade.

Definition at line 373 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 402 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 384 of file class.ilMMAbstractItemFacade.php.

                                                     : void
    {
        $ts = ilMMItemTranslationStorage::where([
            'identification' => $this->identification->serialize(),
        ], '=')->get();
 
        if (!empty($ts)) {
            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 ( )

Returns: int

Implements ilMMItemFacadeInterface.

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

                                         : int
    {
        if ($this->filtered_item instanceof isParent) {
            return count($this->filtered_item->getChildren());
        }
 
        return 0;
    }

◆ getDefaultTitle()

ilMMAbstractItemFacade::getDefaultTitle ( )

Returns: string

Implements ilMMItemFacadeInterface.

Definition at line 188 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().

Here is the call graph for this function:

◆ getFilteredItem()

ilMMAbstractItemFacade::getFilteredItem ( )

Implements ilMMItemFacadeInterface.

Definition at line 142 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 101 of file class.ilMMAbstractItemFacade.php.

                                      : array
    {
        return $this->global_role_ids;
    }

References $global_role_ids.

◆ getIconID()

ilMMAbstractItemFacade::getIconID ( )

Implements ilMMItemFacadeInterface.

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

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

◆ getId()

ilMMAbstractItemFacade::getId ( )

Returns: string

Implements ilMMItemFacadeInterface.

Definition at line 61 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 ( )

Returns: string

Implements ilMMItemFacadeInterface.

Definition at line 231 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 ( )

Returns: string

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade, and ilMMNullItemFacade.

Definition at line 180 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 138 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 ( )

Returns: string

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade.

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

                               : string
    {
        global $DIC;
        if (!$this->raw_item->isAvailable() || $this->raw_item->isAlwaysAvailable()) {
            return $DIC->ui()->renderer()->render($this->raw_item->getNonAvailableReason());
        }
 
        return "";
    }

References $DIC.

◆ getType()

ilMMAbstractItemFacade::getType ( )

FSX check if doublette @inheritDoc.

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade.

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

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

◆ getTypeForPresentation()

ilMMAbstractItemFacade::getTypeForPresentation ( )

Returns: string

Exceptions

ReflectionException

Implements ilMMItemFacadeInterface.

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

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

◆ hasRoleBasedVisibility()

ilMMAbstractItemFacade::hasRoleBasedVisibility ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

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

                                            : bool
    {
        return $this->role_based_visibility;
    }

References $role_based_visibility.

◆ hasStorage()

ilMMAbstractItemFacade::hasStorage ( )

Returns: bool

Implements ilMMItemFacadeInterface.

Definition at line 69 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 ( )

Returns: IdentificationInterface

Implements ilMMItemFacadeInterface.

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

                                    : IdentificationInterface
    {
        return $this->identification;
    }

References $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 164 of file class.ilMMAbstractItemFacade.php.

                                 : bool
    {
        return $this->mm_item->isActive() && $this->getRawItem()->isAvailable() || $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 172 of file class.ilMMAbstractItemFacade.php.

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

References getRawItem().

Here is the call graph for this function:

◆ isAvailable()

ilMMAbstractItemFacade::isAvailable ( )

Returns: bool

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMNullItemFacade.

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

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

◆ isChild()

ilMMAbstractItemFacade::isChild ( )

Returns: bool

Implements ilMMItemFacadeInterface.

Definition at line 279 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 ( )

Returns: bool

Implements ilMMItemFacadeInterface.

Definition at line 250 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,
        ];
        foreach ($known_core_types as $known_core_type) {
            if (get_class($this->raw_item) === $known_core_type) {
                return false;
            }
        }
 
        return true;
    }

◆ isEmpty()

ilMMAbstractItemFacade::isEmpty ( )

Returns: bool

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMNullItemFacade.

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

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

◆ isInLostItem()

ilMMAbstractItemFacade::isInLostItem ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

Definition at line 289 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 309 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 274 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 ( )

Returns: ilMMItemStorage

Implements ilMMItemFacadeInterface.

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

                                 : ilMMItemStorage
    {
        return $this->mm_item;
    }

References $mm_item.

◆ setActiveStatus()

ilMMAbstractItemFacade::setActiveStatus ( bool $status )

Parameters

bool $status

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMNullItemFacade.

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

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

◆ setDefaultTitle()

ilMMAbstractItemFacade::setDefaultTitle ( string $default_title )

Parameters

string $default_title

Implements ilMMItemFacadeInterface.

Definition at line 204 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 109 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 360 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 301 of file class.ilMMAbstractItemFacade.php.

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

◆ setParent()

ilMMAbstractItemFacade::setParent ( string $parent )

Parameters

string $parent

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMNullItemFacade.

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

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

◆ setPosition()

ilMMAbstractItemFacade::setPosition ( int $position )

Parameters

int $position

Implements ilMMItemFacadeInterface.

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

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

◆ setRoleBasedVisibility()

ilMMAbstractItemFacade::setRoleBasedVisibility ( bool $role_based_visibility )

@inheritDoc

Implements ilMMItemFacadeInterface.

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

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

References $role_based_visibility.

◆ supportsCustomIcon()

ilMMAbstractItemFacade::supportsCustomIcon ( )

Returns: bool

Implements ilMMItemFacadeInterface.

Definition at line 347 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 77 of file class.ilMMAbstractItemFacade.php.

                                                 : bool
    {
        return false;
    }

◆ update()

ilMMAbstractItemFacade::update ( )

Returns: void

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade.

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

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