Class ilMMCustomItemFacade. More...

Inheritance diagram for ilMMCustomItemFacade:

Collaboration diagram for ilMMCustomItemFacade:

Public Member Functions

__construct (IdentificationInterface $identification, Main $collector)

@inheritDoc More...

update ()

@inheritDoc More...

delete ()

@inheritDoc More...

supportsRoleBasedVisibility ()

@inheritDoc More...

isCustom ()

@inheritDoc More...

isEditable ()

@inheritDoc More...

isDeletable ()

@inheritDoc More...

getProviderNameForPresentation ()

@inheritDoc More...

getStatus ()

setAction (string $action)

@inheritDoc More...

getType ()

@inheritDoc More...

setType (string $type)

@inheritDoc More...

isTopItem ()

@inheritDoc More...

setIsTopItm (bool $top_item)

@inheritDoc More...

Public Member Functions inherited from ilMMAbstractItemFacade

__construct (\ILIAS\GlobalScreen\Identification\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...

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

@inheritDoc

Reimplemented in ilMMNullItemFacade.

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ delete()

ilMMCustomItemFacade::delete ( )

@inheritDoc

Reimplemented from ilMMAbstractItemFacade.

Reimplemented in ilMMNullItemFacade.

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

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

References getCustomStorage(), and isDeletable().

Here is the call graph for this function:

◆ getCustomStorage()

ilMMCustomItemFacade::getCustomStorage ( )

private

Returns: ilMMCustomItemStorage|null

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

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

References CachedActiveRecord\find().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProviderNameForPresentation()

ilMMCustomItemFacade::getProviderNameForPresentation ( )

@inheritDoc

Reimplemented from ilMMAbstractItemFacade.

Reimplemented in ilMMNullItemFacade.

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

                                                     : string
    {
        return "Custom";
    }

◆ getStatus()

ilMMCustomItemFacade::getStatus ( )

Returns: string

Reimplemented from ilMMAbstractItemFacade.

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

                                : string
    {
        return "";
    }

◆ getType()

ilMMCustomItemFacade::getType ( )

@inheritDoc

Reimplemented from ilMMAbstractItemFacade.

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

                              : string
    {
        return $this->type;
    }

References $type.

Referenced by update().

Here is the caller graph for this function:

◆ isCustom()

ilMMCustomItemFacade::isCustom ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

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

                               : bool
    {
        return true;
    }

Referenced by update().

Here is the caller graph for this function:

◆ isDeletable()

ilMMCustomItemFacade::isDeletable ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMNullItemFacade.

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

                                  : bool
    {
        return true;
    }

Referenced by delete().

Here is the caller graph for this function:

◆ isEditable()

ilMMCustomItemFacade::isEditable ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

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

                                 : bool
    {
        return true;
    }

◆ isTopItem()

ilMMCustomItemFacade::isTopItem ( )

@inheritDoc

Reimplemented from ilMMAbstractItemFacade.

Reimplemented in ilMMNullItemFacade.

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

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

References $top_item.

◆ setAction()

ilMMCustomItemFacade::setAction ( string $action )

@inheritDoc

Implements ilMMItemFacadeInterface.

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

    {
        $this->action = $action;
    }

References $action.

◆ setIsTopItm()

ilMMCustomItemFacade::setIsTopItm ( bool $top_item )

@inheritDoc

Reimplemented from ilMMAbstractItemFacade.

Reimplemented in ilMMNullItemFacade.

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

    {
        $this->top_item = $top_item;
    }

References $top_item.

◆ setType()

ilMMCustomItemFacade::setType ( string $type )

@inheritDoc

Implements ilMMItemFacadeInterface.

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

    {
        $this->type = $type;
    }

References $type.

◆ supportsRoleBasedVisibility()

ilMMCustomItemFacade::supportsRoleBasedVisibility ( )

@inheritDoc

Reimplemented from ilMMAbstractItemFacade.

Reimplemented in ilMMNullItemFacade.

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

                                                  : bool
    {
        return true;
    }

◆ update()

ilMMCustomItemFacade::update ( )

@inheritDoc

Reimplemented from ilMMAbstractItemFacade.

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

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

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

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