Class ilMMCustomItemFacade. More...

Inheritance diagram for ilMMCustomItemFacade:

Collaboration diagram for ilMMCustomItemFacade:

Public Member Functions

__construct (IdentificationInterface $identification, Main $collector)

update ()

delete ()

supportsRoleBasedVisibility ()

isCustom ()

isEditable ()

isDeletable ()

getProviderNameForPresentation ()

getStatus ()

setAction (string $action)

getType ()

setType (string $type)

isTopItem ()

setIsTopItm (bool $top_item)

Public Member Functions inherited from ilMMAbstractItemFacade

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

Protected Attributes
	$custom_item_storage

	$action = ''

	$type = ''

	$top_item = false

Protected Attributes inherited from ilMMAbstractItemFacade
	$role_based_visibility = false

	$global_role_ids = []

	$type_information

	$mm_item

	$raw_item

	$filtered_item

	$identification

	$default_title = "-"

Private Member Functions
	getCustomStorage ()

Additional Inherited Members
Protected Member Functions inherited from ilMMAbstractItemFacade
	deleteAssociatedTranslations ()
	deletes all translations associated with the current identification. More...

Detailed Description

Class ilMMCustomItemFacade.

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

Definition at line 10 of file class.ilMMCustomItemFacade.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

References ILIAS\GlobalScreen\Provider\__construct(), and getCustomStorage().

     {
         parent::__construct($identification, $collector);
         $this->custom_item_storage = $this->getCustomStorage();
         if ($this->custom_item_storage instanceof ilMMCustomItemStorage) {
             if ($this->custom_item_storage->getType()) {
                 $this->type = $this->custom_item_storage->getType();
             }
             $this->role_based_visibility = $this->custom_item_storage->hasRoleBasedVisibility();
             if ($this->custom_item_storage->hasRoleBasedVisibility()) {
                 $this->global_role_ids = $this->custom_item_storage->getGlobalRoleIDs();
             }
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ delete()

ilMMCustomItemFacade::delete ( )

Implements ilMMItemFacadeInterface.

Definition at line 72 of file class.ilMMCustomItemFacade.php.

References getCustomStorage(), and isDeletable().

     {
         if (!$this->isDeletable()) {
             throw new LogicException("Non Custom items can't be deleted");
         }
 
         $cm = $this->getCustomStorage();
         if ($cm instanceof ilMMCustomItemStorage) {
             $cm->delete();
         }
         parent::delete();
     }

Here is the call graph for this function:

◆ getCustomStorage()

ilMMCustomItemFacade::getCustomStorage ( )

private

Returns: ilMMCustomItemStorage|null

Definition at line 88 of file class.ilMMCustomItemFacade.php.

References CachedActiveRecord\find().

Referenced by __construct(), delete(), and update().

     {
         $id = $this->raw_item->getProviderIdentification()->getInternalIdentifier();
         $mm = ilMMCustomItemStorage::find($id);
 
         return $mm;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProviderNameForPresentation()

ilMMCustomItemFacade::getProviderNameForPresentation ( )

Implements ilMMItemFacadeInterface.

Definition at line 131 of file class.ilMMCustomItemFacade.php.

                                                      : string
     {
         return "Custom";
     }

◆ getStatus()

ilMMCustomItemFacade::getStatus ( )

Returns: string

Implements ilMMItemFacadeInterface.

Definition at line 139 of file class.ilMMCustomItemFacade.php.

                                 : string
     {
         return "";
     }

◆ getType()

ilMMCustomItemFacade::getType ( )

Implements ilMMItemFacadeInterface.

Definition at line 155 of file class.ilMMCustomItemFacade.php.

References $type.

Referenced by update().

                               : string
     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ isCustom()

ilMMCustomItemFacade::isCustom ( )

Implements ilMMItemFacadeInterface.

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

Referenced by update().

                                : bool
     {
         return true;
     }

Here is the caller graph for this function:

◆ isDeletable()

ilMMCustomItemFacade::isDeletable ( )

Implements ilMMItemFacadeInterface.

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

Referenced by delete().

                                   : bool
     {
         return true;
     }

Here is the caller graph for this function:

◆ isEditable()

ilMMCustomItemFacade::isEditable ( )

Implements ilMMItemFacadeInterface.

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

                                  : bool
     {
         return true;
     }

◆ isTopItem()

ilMMCustomItemFacade::isTopItem ( )

Implements ilMMItemFacadeInterface.

Definition at line 171 of file class.ilMMCustomItemFacade.php.

References $top_item.

                                 : bool
     {
         if ($this->raw_item instanceof \ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem) {
             return parent::isTopItem();
         }
 
         return $this->top_item;
     }

◆ setAction()

ilMMCustomItemFacade::setAction ( string $action )

Implements ilMMItemFacadeInterface.

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

References $action.

     {
         $this->action = $action;
     }

◆ setIsTopItm()

ilMMCustomItemFacade::setIsTopItm ( bool $top_item )

Implements ilMMItemFacadeInterface.

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

References $top_item.

     {
         $this->top_item = $top_item;
     }

◆ setType()

ilMMCustomItemFacade::setType ( string $type )

Implements ilMMItemFacadeInterface.

Definition at line 163 of file class.ilMMCustomItemFacade.php.

References $type.

     {
         $this->type = $type;
     }

◆ supportsRoleBasedVisibility()

ilMMCustomItemFacade::supportsRoleBasedVisibility ( )

Implements ilMMItemFacadeInterface.

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

                                                   : bool
     {
         return true;
     }

◆ update()

ilMMCustomItemFacade::update ( )

Implements ilMMItemFacadeInterface.

Definition at line 51 of file class.ilMMCustomItemFacade.php.

References ilMMAbstractItemFacade\$default_title, getCustomStorage(), getType(), ilMMAbstractItemFacade\identification(), and isCustom().

     {
         if ($this->isCustom()) {
             $mm = $this->getCustomStorage();
             if ($mm instanceof ilMMCustomItemStorage) {
                 $default_title = ilMMItemTranslationStorage::getDefaultTranslation($this->identification());
                 $mm->setDefaultTitle($default_title);
                 $mm->setType($this->getType());
                 $mm->setRoleBasedVisibility($this->role_based_visibility);
                 if ($this->role_based_visibility) {
                     $mm->setGlobalRoleIDs($this->global_role_ids);
                 }
                 $mm->update();
             }
         }
         parent::update();
     }

Here is the call graph for this function:

Field Documentation

◆ $action

ilMMCustomItemFacade::$action = ''

protected

Definition at line 20 of file class.ilMMCustomItemFacade.php.

Referenced by setAction().

◆ $custom_item_storage

ilMMCustomItemFacade::$custom_item_storage

protected

Definition at line 16 of file class.ilMMCustomItemFacade.php.

◆ $top_item

ilMMCustomItemFacade::$top_item = false

protected

Definition at line 28 of file class.ilMMCustomItemFacade.php.

Referenced by isTopItem(), and setIsTopItm().

◆ $type

ilMMCustomItemFacade::$type = ''

protected

Definition at line 24 of file class.ilMMCustomItemFacade.php.

Referenced by getType(), and setType().

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

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

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ getCustomStorage()

◆ getProviderNameForPresentation()

◆ getStatus()

◆ getType()

◆ isCustom()

◆ isDeletable()

◆ isEditable()

◆ isTopItem()

◆ setAction()

◆ setIsTopItm()

◆ setType()

◆ supportsRoleBasedVisibility()

◆ update()

Field Documentation

◆ $action

◆ $custom_item_storage

◆ $top_item

◆ $type