Class ilMMAbstractItemFacade. More...

Inheritance diagram for ilMMAbstractItemFacade:

Collaboration diagram for ilMMAbstractItemFacade:

Public Member Functions

__construct (\ILIAS\GlobalScreen\Identification\IdentificationInterface $identification, Main $collector)

ilMMAbstractItemFacade constructor. More...

getId ()

hasStorage ()

supportsRoleBasedVisibility ()

hasRoleBasedVisibility ()

setRoleBasedVisibility (bool $role_based_visibility)

getGlobalRoleIDs ()

setGlobalRoleIDs (array $global_role_ids)

isEmpty ()

itemStorage ()

identification ()

getRawItem ()

getFilteredItem ()

getAmountOfChildren ()

isAvailable ()

isActivated ()

isAlwaysAvailable ()

getProviderNameForPresentation ()

getDefaultTitle ()

setDefaultTitle (string $default_title)

getStatus ()

getTypeForPresentation ()

getParentIdentificationString ()

isCustomType ()

isTopItem ()

isChild ()

isInLostItem ()

setIsTopItm (bool $top_item)

isInterchangeable ()

getType ()

FSX check if doublette . More...

setParent (string $parent)

setPosition (int $position)

Parameters

int $position

More...

setActiveStatus (bool $status)

supportsCustomIcon ()

getIconID ()

setIconID (string $icon_id)

update ()

create ()

delete ()

Public Member Functions inherited from ilMMItemFacadeInterface

isEditable ()

isDeletable ()

isCustom ()

setAction (string $action)

setType (string $type)

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

Protected Attributes
	$role_based_visibility = false

	$global_role_ids = []

	$type_information

	$mm_item

	$raw_item

	$filtered_item

	$identification

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

Constructor & Destructor Documentation

◆ __construct()

ilMMAbstractItemFacade::__construct	(	\ILIAS\GlobalScreen\Identification\IdentificationInterface	$identification,
		Main	$collector
	)

ilMMAbstractItemFacade constructor.

Parameters

\ILIAS\GlobalScreen\Identification\IdentificationInterface	$identification
Main	$collector

Exceptions

Throwable

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

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

       {
         $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);
     }

Here is the call graph for this function:

Member Function Documentation

◆ create()

ilMMAbstractItemFacade::create ( )

Returns: void

Implements ilMMItemFacadeInterface.

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

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

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

Here is the call graph for this function:

◆ delete()

ilMMAbstractItemFacade::delete ( )

Implements ilMMItemFacadeInterface.

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

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

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

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

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

Referenced by delete().

     {
         $ts = ilMMItemTranslationStorage::where([
             'identification' => $this->identification->serialize(),
         ], '=')->get();
 
         if (!empty($ts)) {
             foreach ($ts as $translation) {
                 if ($translation instanceof ilMMItemTranslationStorage) {
                     $translation->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 163 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 204 of file class.ilMMAbstractItemFacade.php.

References $default_title, and identification().

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

Here is the call graph for this function:

◆ getFilteredItem()

ilMMAbstractItemFacade::getFilteredItem ( )

Implements ilMMItemFacadeInterface.

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

References $filtered_item.

                                       : isItem
     {
         return $this->filtered_item;
     }

◆ getGlobalRoleIDs()

ilMMAbstractItemFacade::getGlobalRoleIDs ( )

Implements ilMMItemFacadeInterface.

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

References $global_role_ids.

                                        : array
     {
         return $this->global_role_ids;
     }

◆ getIconID()

ilMMAbstractItemFacade::getIconID ( )

Implements ilMMItemFacadeInterface.

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

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

◆ getId()

ilMMAbstractItemFacade::getId ( )

Returns: string

Implements ilMMItemFacadeInterface.

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

References identification().

Referenced by hasStorage().

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

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

                                                     : string
     {
         if ($this->raw_item instanceof isChild) {
             $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 "";
     }

◆ getProviderNameForPresentation()

ilMMAbstractItemFacade::getProviderNameForPresentation ( )

Returns: string

Implements ilMMItemFacadeInterface.

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

References identification().

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

Here is the call graph for this function:

◆ getRawItem()

ilMMAbstractItemFacade::getRawItem ( )

Implements ilMMItemFacadeInterface.

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

References $raw_item.

Referenced by isActivated(), isAlwaysAvailable(), and isChild().

                                  : isItem
     {
         return $this->raw_item;
     }

Here is the caller graph for this function:

◆ getStatus()

ilMMAbstractItemFacade::getStatus ( )

Returns: string

Implements ilMMItemFacadeInterface.

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

References $DIC.

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

◆ getType()

ilMMAbstractItemFacade::getType ( )

FSX check if doublette .

Implements ilMMItemFacadeInterface.

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

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

◆ getTypeForPresentation()

ilMMAbstractItemFacade::getTypeForPresentation ( )

Returns: string

Exceptions

ReflectionException

Implements ilMMItemFacadeInterface.

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

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

◆ hasRoleBasedVisibility()

ilMMAbstractItemFacade::hasRoleBasedVisibility ( )

Implements ilMMItemFacadeInterface.

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

References $role_based_visibility.

                                              : bool
     {
         return $this->role_based_visibility;
     }

◆ hasStorage()

ilMMAbstractItemFacade::hasStorage ( )

Returns: bool

Implements ilMMItemFacadeInterface.

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

References CachedActiveRecord\find(), and getId().

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

Here is the call graph for this function:

◆ identification()

ilMMAbstractItemFacade::identification ( )

Returns

Implements ilMMItemFacadeInterface.

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

References $identification.

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

                                      : \ILIAS\GlobalScreen\Identification\IdentificationInterface
     {
         return $this->identification;
     }

Here is the caller graph for this function:

◆ isActivated()

ilMMAbstractItemFacade::isActivated ( )

Implements ilMMItemFacadeInterface.

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

References getRawItem().

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

Here is the call graph for this function:

◆ isAlwaysAvailable()

ilMMAbstractItemFacade::isAlwaysAvailable ( )

Implements ilMMItemFacadeInterface.

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

References getRawItem().

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

Here is the call graph for this function:

◆ isAvailable()

ilMMAbstractItemFacade::isAvailable ( )

Returns: bool

Implements ilMMItemFacadeInterface.

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

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

◆ isChild()

ilMMAbstractItemFacade::isChild ( )

Returns: bool

Implements ilMMItemFacadeInterface.

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

References getRawItem().

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

Here is the call graph for this function:

◆ isCustomType()

ilMMAbstractItemFacade::isCustomType ( )

Returns: bool

Implements ilMMItemFacadeInterface.

Definition at line 266 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.

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

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

◆ isInLostItem()

ilMMAbstractItemFacade::isInLostItem ( )

Implements ilMMItemFacadeInterface.

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

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

◆ isInterchangeable()

ilMMAbstractItemFacade::isInterchangeable ( )

Implements ilMMItemFacadeInterface.

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

                                         : bool
     {
         return false;
     }

◆ isTopItem()

ilMMAbstractItemFacade::isTopItem ( )

Implements ilMMItemFacadeInterface.

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

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

◆ itemStorage()

ilMMAbstractItemFacade::itemStorage ( )

Returns: ilMMItemStorage

Implements ilMMItemFacadeInterface.

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

References $mm_item.

                                   : ilMMItemStorage
     {
         return $this->mm_item;
     }

◆ setActiveStatus()

ilMMAbstractItemFacade::setActiveStatus ( bool $status )

Parameters

bool $status

Implements ilMMItemFacadeInterface.

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

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

◆ setDefaultTitle()

ilMMAbstractItemFacade::setDefaultTitle ( string $default_title )

Parameters

string $default_title

Implements ilMMItemFacadeInterface.

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

References $default_title.

     {
         $this->default_title = $default_title;
     }

◆ setGlobalRoleIDs()

ilMMAbstractItemFacade::setGlobalRoleIDs ( array $global_role_ids )

Implements ilMMItemFacadeInterface.

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

References $global_role_ids.

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

◆ setIconID()

ilMMAbstractItemFacade::setIconID ( string $icon_id )

Implements ilMMItemFacadeInterface.

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

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

◆ setIsTopItm()

ilMMAbstractItemFacade::setIsTopItm ( bool $top_item )

Implements ilMMItemFacadeInterface.

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

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

◆ setParent()

ilMMAbstractItemFacade::setParent ( string $parent )

Parameters

string $parent

Implements ilMMItemFacadeInterface.

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

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

◆ setPosition()

ilMMAbstractItemFacade::setPosition ( int $position )

Parameters

int $position

Implements ilMMItemFacadeInterface.

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

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

◆ setRoleBasedVisibility()

ilMMAbstractItemFacade::setRoleBasedVisibility ( bool $role_based_visibility )

Implements ilMMItemFacadeInterface.

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

References $role_based_visibility.

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

◆ supportsCustomIcon()

ilMMAbstractItemFacade::supportsCustomIcon ( )

Returns: bool

Implements ilMMItemFacadeInterface.

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

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

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

Here is the call graph for this function:

◆ supportsRoleBasedVisibility()

ilMMAbstractItemFacade::supportsRoleBasedVisibility ( )

Implements ilMMItemFacadeInterface.

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

                                                   : bool
     {
         return false;
     }

◆ update()

ilMMAbstractItemFacade::update ( )

Returns: void

Implements ilMMItemFacadeInterface.

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

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

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

Here is the call graph for this function:

Field Documentation

◆ $default_title

ilMMAbstractItemFacade::$default_title = "-"

protected

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

Referenced by getDefaultTitle(), setDefaultTitle(), and ilMMCustomItemFacade\update().

◆ $filtered_item

ilMMAbstractItemFacade::$filtered_item

protected

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

Referenced by getFilteredItem().

◆ $global_role_ids

ilMMAbstractItemFacade::$global_role_ids = []

protected

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

Referenced by getGlobalRoleIDs(), and setGlobalRoleIDs().

◆ $identification

ilMMAbstractItemFacade::$identification

protected

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

Referenced by ilMMNullItemFacade\__construct(), __construct(), and identification().

◆ $mm_item

ilMMAbstractItemFacade::$mm_item

protected

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

Referenced by itemStorage().

◆ $raw_item

ilMMAbstractItemFacade::$raw_item

protected

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

Referenced by getRawItem().

◆ $role_based_visibility

ilMMAbstractItemFacade::$role_based_visibility = false

protected

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

Referenced by hasRoleBasedVisibility(), and setRoleBasedVisibility().

◆ $type_information

ilMMAbstractItemFacade::$type_information

protected

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

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

Services/MainMenu/classes/Items/Facade/class.ilMMAbstractItemFacade.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ create()

◆ delete()

◆ deleteAssociatedTranslations()

◆ getAmountOfChildren()

◆ getDefaultTitle()

◆ getFilteredItem()

◆ getGlobalRoleIDs()

◆ getIconID()

◆ getId()

◆ getParentIdentificationString()

◆ getProviderNameForPresentation()

◆ getRawItem()

◆ getStatus()

◆ 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

◆ $identification

◆ $mm_item

◆ $raw_item

◆ $role_based_visibility

◆ $type_information