ilMMAbstractItemFacade Class Reference

Class ilMMAbstractItemFacade. More...

Inheritance diagram for ilMMAbstractItemFacade:

Collaboration diagram for ilMMAbstractItemFacade:

Public Member Functions
	__construct (protected 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
bool	$role_based_visibility = false
array	$global_role_ids = []
TypeInformation	$type_information
ilMMItemStorage	$mm_item
isItem	$filtered_item
isItem	$raw_item
string	$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 45 of file class.ilMMAbstractItemFacade.php.

Constructor & Destructor Documentation

__construct()

ilMMAbstractItemFacade::__construct	(	protected IdentificationInterface	$identification,
		Main	$collector
	)

ilMMAbstractItemFacade constructor.

Parameters

IdentificationInterface	$identification
Main	$collector

Exceptions

Throwable

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

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

      {
        $this->raw_item = $collector->getSingleItemFromRaw($this->identification);
        $this->filtered_item = $collector->getSingleItemFromFilter($this->identification);
        $this->type_information = $collector->getTypeInformationCollection()->get($this->raw_item::class);
        $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 386 of file class.ilMMAbstractItemFacade.php.

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

                            : void
    {
        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 415 of file class.ilMMAbstractItemFacade.php.

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

                            : void
    {
        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 397 of file class.ilMMAbstractItemFacade.php.

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

Referenced by delete().

                                                     : void
    {
        $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 160 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 207 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 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 155 of file class.ilMMAbstractItemFacade.php.

References $filtered_item.

Referenced by getParentIdentificationString(), and isChild().

                                     : isItem
    {
        return $this->filtered_item;
    }

Here is the caller graph for this function:

getGlobalRoleIDs()

ilMMAbstractItemFacade::getGlobalRoleIDs

(

)

Implements ilMMItemFacadeInterface.

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

References $global_role_ids.

                                      : array
    {
        return $this->global_role_ids;
    }

getIconID()

ilMMAbstractItemFacade::getIconID

(

)

Implements ilMMItemFacadeInterface.

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

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

getId()

ilMMAbstractItemFacade::getId

(

)

Returns

string

Implements ilMMItemFacadeInterface.

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

References getFilteredItem().

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

Here is the call graph for this function:

getProviderNameForPresentation()

ilMMAbstractItemFacade::getProviderNameForPresentation

(

)

Returns

string

Implements ilMMItemFacadeInterface.

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

References $raw_item.

Referenced by isActivated(), and isAlwaysAvailable().

                                : isItem
    {
        return $this->raw_item;
    }

Here is the caller graph for this function:

getStatus()

ilMMAbstractItemFacade::getStatus

(

)

Returns

string

Implements ilMMItemFacadeInterface.

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

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

getTypeForPresentation()

ilMMAbstractItemFacade::getTypeForPresentation

(

)

Returns

string

Exceptions

ReflectionException

Implements ilMMItemFacadeInterface.

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

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

hasRoleBasedVisibility()

ilMMAbstractItemFacade::hasRoleBasedVisibility

(

)

Implements ilMMItemFacadeInterface.

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

References getId(), and null.

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

Here is the call graph for this function:

identification()

ilMMAbstractItemFacade::identification

(

)

Returns

IdentificationInterface

Implements ilMMItemFacadeInterface.

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

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

                                    : 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
    {
        if ($this->mm_item->isActive() && $this->getRawItem()->isAvailable()) {
            return true;
        }
        return $this->getRawItem()->isAlwaysAvailable();
    }

Here is the call graph for this function:

isAlwaysAvailable()

ilMMAbstractItemFacade::isAlwaysAvailable

(

)

Implements ilMMItemFacadeInterface.

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

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

isChild()

ilMMAbstractItemFacade::isChild

(

)

Returns

bool

Implements ilMMItemFacadeInterface.

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

References getFilteredItem(), and ILIAS\GlobalScreen\Scope\MainMenu\Factory\isInterchangeableItem\hasChanged().

                             : bool
    {
        $item = $this->getFilteredItem();
        return $item instanceof isChild
            || ($item instanceof isInterchangeableItem && $item->hasChanged());
    }

Here is the call graph for this function:

isCustomType()

ilMMAbstractItemFacade::isCustomType

(

)

Returns

bool

Implements ilMMItemFacadeInterface.

Definition at line 269 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,
        ];
        return !in_array($this->raw_item::class, $known_core_types, true);
    }

isEmpty()

ilMMAbstractItemFacade::isEmpty

(

)

Returns

bool

Implements ilMMItemFacadeInterface.

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

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

isInLostItem()

ilMMAbstractItemFacade::isInLostItem

(

)

Implements ilMMItemFacadeInterface.

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

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

isTopItem()

ilMMAbstractItemFacade::isTopItem

(

)

Implements ilMMItemFacadeInterface.

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

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

itemStorage()

ilMMAbstractItemFacade::itemStorage

(

)

Returns

ilMMItemStorage

Implements ilMMItemFacadeInterface.

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

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

setDefaultTitle()

ilMMAbstractItemFacade::setDefaultTitle

(

string

$default_title

)

Parameters

string

$default_title

Implements ilMMItemFacadeInterface.

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

References $default_title.

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

setGlobalRoleIDs()

ilMMAbstractItemFacade::setGlobalRoleIDs

(

array

$global_role_ids

)

Implements ilMMItemFacadeInterface.

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

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

setIsTopItm()

ilMMAbstractItemFacade::setIsTopItm

(

bool

$top_item

)

Implements ilMMItemFacadeInterface.

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

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

setParent()

ilMMAbstractItemFacade::setParent

(

string

$parent

)

Parameters

string

$parent

Implements ilMMItemFacadeInterface.

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

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

setPosition()

ilMMAbstractItemFacade::setPosition

(

int

$position

)

Parameters

int

$position

Implements ilMMItemFacadeInterface.

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

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

setRoleBasedVisibility()

ilMMAbstractItemFacade::setRoleBasedVisibility

(

bool

$role_based_visibility

)

Implements ilMMItemFacadeInterface.

Definition at line 106 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 360 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 90 of file class.ilMMAbstractItemFacade.php.

                                                 : bool
    {
        return false;
    }

update()

ilMMAbstractItemFacade::update

(

)

Returns

void

Implements ilMMItemFacadeInterface.

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

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

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

Here is the call graph for this function:

Field Documentation

$default_title

string ilMMAbstractItemFacade::$default_title = "-"

protected

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

Referenced by getDefaultTitle(), and setDefaultTitle().

$filtered_item

isItem ilMMAbstractItemFacade::$filtered_item

protected

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

Referenced by getFilteredItem().

$global_role_ids

array ilMMAbstractItemFacade::$global_role_ids = []

protected

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

Referenced by getGlobalRoleIDs(), and setGlobalRoleIDs().

$mm_item

ilMMItemStorage ilMMAbstractItemFacade::$mm_item

protected

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

Referenced by itemStorage().

$raw_item

isItem ilMMAbstractItemFacade::$raw_item

protected

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

Referenced by getRawItem().

$role_based_visibility

bool ilMMAbstractItemFacade::$role_based_visibility = false

protected

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

Referenced by hasRoleBasedVisibility(), and setRoleBasedVisibility().

$type_information

TypeInformation ilMMAbstractItemFacade::$type_information

protected

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

---

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

• components/ILIAS/MainMenu/classes/Items/Facade/class.ilMMAbstractItemFacade.php