ilMMAbstractItemFacade Class Reference

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 ()
	isAlwaysAvailable ()
	getProviderNameForPresentation ()
	getDefaultTitle ()
	setDefaultTitle (string $default_title)
	getStatus ()
	getTypeForPresentation ()
	getParentIdentificationString ()
	isCustomType ()
	isTopItem ()
	isInLostItem ()
	setIsTopItm (bool $top_item)
	getType ()
	FSX check if doublette. More...
	setParent (string $parent)
	setPosition (int $position)
	Parameters int $position More...
	setActiveStatus (bool $status)
	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
	$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

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

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

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

Here is the call graph for this function:

Member Function Documentation

create()

ilMMAbstractItemFacade::create

(

)

Returns

void

Implements ilMMItemFacadeInterface.

Definition at line 323 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->gs_item);
    }

Here is the call graph for this function:

delete()

ilMMAbstractItemFacade::delete

(

)

Implements ilMMItemFacadeInterface.

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

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

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

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.

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

References $default_title, and identification().

                                      : 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;
    }

Here is the call graph for this function:

getId()

ilMMAbstractItemFacade::getId

(

)

Returns

string

Implements ilMMItemFacadeInterface.

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

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

References identification().

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

Here is the call graph for this function:

getStatus()

ilMMAbstractItemFacade::getStatus

(

)

Returns

string

Implements ilMMItemFacadeInterface.

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

References $DIC.

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

        return "";
    }

getType()

ilMMAbstractItemFacade::getType

(

)

FSX check if doublette.

Implements ilMMItemFacadeInterface.

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.

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

References item().

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

Here is the call graph for this function:

isAlwaysAvailable()

ilMMAbstractItemFacade::isAlwaysAvailable

(

)

Implements ilMMItemFacadeInterface.

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

References item().

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

Here is the call graph for this function:

isAvailable()

ilMMAbstractItemFacade::isAvailable

(

)

Returns

bool

Implements ilMMItemFacadeInterface.

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

References item().

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

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.

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

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

isInLostItem()

ilMMAbstractItemFacade::isInLostItem

(

)

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

(

)

Implements ilMMItemFacadeInterface.

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

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

item()

ilMMAbstractItemFacade::item

(

)

Returns

isItem

Implements ilMMItemFacadeInterface.

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

References $gs_item.

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

                           : isItem
    {
        return $this->gs_item;
    }

Here is the caller graph for this function:

itemStorage()

ilMMAbstractItemFacade::itemStorage

(

)

Returns

ilMMItemStorage

Implements ilMMItemFacadeInterface.

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

References $default_title.

    {
        $this->default_title = $default_title;
    }

setIsTopItm()

ilMMAbstractItemFacade::setIsTopItm

(

bool

$top_item

)

Implements ilMMItemFacadeInterface.

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

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

setParent()

ilMMAbstractItemFacade::setParent

(

string

$parent

)

Parameters

string

$parent

Implements ilMMItemFacadeInterface.

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.

Definition at line 316 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 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 ilMMNullItemFacade\__construct(), __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