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

isEmpty ()

itemStorage ()

identification ()

item ()

getAmountOfChildren ()

isAvailable ()

isActivated ()

@inheritDoc More...

isAlwaysAvailable ()

@inheritDoc More...

getProviderNameForPresentation ()

getDefaultTitle ()

setDefaultTitle (string $default_title)

getStatus ()

getTypeForPresentation ()

getParentIdentificationString ()

isCustomType ()

isTopItem ()

@inheritDoc More...

isInLostItem ()

@inheritDoc More...

setIsTopItm (bool $top_item)

@inheritDoc More...

getType ()

FSX check if doublette. More...

setParent (string $parent)

setPosition (int $position)

Parameters

int $position

More...

setActiveStatus (bool $status)

update ()

create ()

delete ()

@inheritDoc More...

Public Member Functions inherited from ilMMItemFacadeInterface

itemStorage ()

item ()

identification ()

getTypeForPresentation ()

getProviderNameForPresentation ()

getStatus ()

isAvailable ()

isActivated ()

isEditable ()

isDeletable ()

isAlwaysAvailable ()

getDefaultTitle ()

getId ()

getAmountOfChildren ()

hasStorage ()

isEmpty ()

isCustom ()

isCustomType ()

getParentIdentificationString ()

getType ()

isTopItem ()

isInLostItem ()

setAction (string $action)

setActiveStatus (bool $status)

setDefaultTitle (string $default_title)

setPosition (int $position)

setParent (string $parent)

setType (string $type)

setIsTopItm (bool $top_item)

update ()

create ()

delete ()

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

Protected Attributes
	$type_information

	$mm_item

	$gs_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 22 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

Reimplemented in ilMMItemFacade.

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

    {
        $this->identification = $identification;
        $this->gs_item = $collector->getSingleItem($identification);
        $this->type_information = $collector->getTypeInformationCollection()->get(get_class($this->gs_item));
        $this->mm_item = ilMMItemStorage::register($this->gs_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 323 of file class.ilMMAbstractItemFacade.php.

    {
        ilMMItemTranslationStorage::storeDefaultTranslation($this->identification, $this->default_title);
        $this->mm_item->create();
        ilMMItemStorage::register($this->gs_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 352 of file class.ilMMAbstractItemFacade.php.

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

References deleteAssociatedTranslations(), CachedActiveRecord\find(), 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 334 of file class.ilMMAbstractItemFacade.php.

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

                                          : int
    {
        if ($this->gs_item instanceof \ILIAS\GlobalScreen\Scope\MainMenu\Factory\isParent) {
            return count($this->gs_item->getChildren());
        }
 
        return 0;
    }

◆ getDefaultTitle()

ilMMAbstractItemFacade::getDefaultTitle ( )

Returns: string

Implements ilMMItemFacadeInterface.

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

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

References $default_title, and identification().

Here is the call graph for this function:

◆ getId()

ilMMAbstractItemFacade::getId ( )

Returns: string

Implements ilMMItemFacadeInterface.

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

                                                    : string
    {
        if ($this->gs_item instanceof isChild) {
            $provider_name_for_presentation = $this->gs_item->getParent()->serialize();
 
            return $provider_name_for_presentation;
        }
 
        return "";
    }

◆ getProviderNameForPresentation()

ilMMAbstractItemFacade::getProviderNameForPresentation ( )

Returns: string

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade, and ilMMNullItemFacade.

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

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

References identification().

Here is the call graph for this function:

◆ getStatus()

ilMMAbstractItemFacade::getStatus ( )

Returns: string

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade.

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

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

References $DIC.

◆ getType()

ilMMAbstractItemFacade::getType ( )

FSX check if doublette.

@inheritDoc

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade.

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

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

◆ getTypeForPresentation()

ilMMAbstractItemFacade::getTypeForPresentation ( )

Returns: string

Exceptions

ReflectionException

Implements ilMMItemFacadeInterface.

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

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

◆ hasStorage()

ilMMAbstractItemFacade::hasStorage ( )

Returns: bool

Implements ilMMItemFacadeInterface.

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

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

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

Here is the call graph for this function:

◆ identification()

ilMMAbstractItemFacade::identification ( )

Returns: \ILIAS\GlobalScreen\Identification\IdentificationInterface

Implements ilMMItemFacadeInterface.

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

                                     : \ILIAS\GlobalScreen\Identification\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 134 of file class.ilMMAbstractItemFacade.php.

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

References item().

Here is the call graph for this function:

◆ isAlwaysAvailable()

ilMMAbstractItemFacade::isAlwaysAvailable ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMNullItemFacade.

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

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

References item().

Here is the call graph for this function:

◆ isAvailable()

ilMMAbstractItemFacade::isAvailable ( )

Returns: bool

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMNullItemFacade.

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

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

References item().

Here is the call graph for this function:

◆ isCustomType()

ilMMAbstractItemFacade::isCustomType ( )

Returns: bool

Implements ilMMItemFacadeInterface.

Definition at line 223 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->gs_item) === $known_core_type) {
                return false;
            }
        }
 
        return true;
    }

◆ isEmpty()

ilMMAbstractItemFacade::isEmpty ( )

Returns: bool

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMNullItemFacade.

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

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

◆ isInLostItem()

ilMMAbstractItemFacade::isInLostItem ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

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

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

◆ isTopItem()

ilMMAbstractItemFacade::isTopItem ( )

@inheritDoc

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade, and ilMMNullItemFacade.

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

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

References isTopItem().

Referenced by isTopItem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ item()

ilMMAbstractItemFacade::item ( )

Returns: isItem

Implements ilMMItemFacadeInterface.

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

                           : isItem
    {
        return $this->gs_item;
    }

References $gs_item.

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

Here is the caller graph for this function:

◆ itemStorage()

ilMMAbstractItemFacade::itemStorage ( )

Returns: ilMMItemStorage

Implements ilMMItemFacadeInterface.

Definition at line 91 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 308 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 178 of file class.ilMMAbstractItemFacade.php.

    {
        $this->default_title = $default_title;
    }

References $default_title.

◆ setIsTopItm()

ilMMAbstractItemFacade::setIsTopItm ( bool $top_item )

@inheritDoc

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade, and ilMMNullItemFacade.

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

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

◆ setParent()

ilMMAbstractItemFacade::setParent ( string $parent )

Parameters

string $parent

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMNullItemFacade.

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

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

◆ setPosition()

ilMMAbstractItemFacade::setPosition ( int $position )

Parameters

int $position

Implements ilMMItemFacadeInterface.

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

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

◆ update()

ilMMAbstractItemFacade::update ( )

Returns: void

Implements ilMMItemFacadeInterface.

Reimplemented in ilMMCustomItemFacade.

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

    {
        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

ilMMAbstractItemFacade::$default_title = "-"

protected

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

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

◆ $gs_item

ilMMAbstractItemFacade::$gs_item

protected

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

Referenced by item().

◆ $identification

ilMMAbstractItemFacade::$identification

protected

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

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

◆ $mm_item

ilMMAbstractItemFacade::$mm_item

protected

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

Referenced by itemStorage().

◆ $type_information

ilMMAbstractItemFacade::$type_information

protected

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

◆ getId()

◆ getParentIdentificationString()

◆ getProviderNameForPresentation()

◆ getStatus()

◆ getType()

◆ getTypeForPresentation()

◆ hasStorage()

◆ identification()

◆ isActivated()

◆ isAlwaysAvailable()

◆ isAvailable()

◆ isCustomType()

◆ isEmpty()

◆ isInLostItem()

◆ isTopItem()

◆ item()

◆ itemStorage()

◆ setActiveStatus()

◆ setDefaultTitle()

◆ setIsTopItm()

◆ setParent()

◆ setPosition()

◆ update()

Field Documentation

◆ $default_title

◆ $gs_item

◆ $identification

◆ $mm_item

◆ $type_information