ilMMCustomItemFacade Class Reference

Class ilMMCustomItemFacade. More...

Inheritance diagram for ilMMCustomItemFacade:

Collaboration diagram for ilMMCustomItemFacade:

Public Member Functions
	__construct (IdentificationInterface $identification, Main $collector)
	update ()
	delete ()
	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 ()
	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 ()

Protected Attributes
	$custom_item_storage
	$action = ''
	$type = ''
	$top_item = false
Protected Attributes inherited from ilMMAbstractItemFacade
	$type_information
	$mm_item
	$gs_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 11 of file class.ilMMCustomItemFacade.php.

Constructor & Destructor Documentation

__construct()

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

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

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

Here is the call graph for this function:

Member Function Documentation

delete()

ilMMCustomItemFacade::delete

(

)

Implements ilMMItemFacadeInterface.

Definition at line 68 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 85 of file class.ilMMCustomItemFacade.php.

References $id, and CachedActiveRecord\find().

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

    {
        $id = $this->gs_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 124 of file class.ilMMCustomItemFacade.php.

                                                     : string
    {
        return "Custom";
    }

getStatus()

ilMMCustomItemFacade::getStatus

(

)

Returns

string

Implements ilMMItemFacadeInterface.

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

                                : string
    {
        return "";
    }

getType()

ilMMCustomItemFacade::getType

(

)

Implements ilMMItemFacadeInterface.

Definition at line 151 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 97 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 115 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 106 of file class.ilMMCustomItemFacade.php.

                                 : bool
    {
        return true;
    }

isTopItem()

ilMMCustomItemFacade::isTopItem

(

)

Implements ilMMItemFacadeInterface.

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

References $top_item.

                                : bool
    {
        if ($this->gs_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 142 of file class.ilMMCustomItemFacade.php.

References $action.

    {
        $this->action = $action;
    }

setIsTopItm()

ilMMCustomItemFacade::setIsTopItm

(

bool

$top_item

)

Implements ilMMItemFacadeInterface.

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

References $top_item.

    {
        $this->top_item = $top_item;
    }

setType()

ilMMCustomItemFacade::setType

(

string

$type

)

Implements ilMMItemFacadeInterface.

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

References $type.

    {
        $this->type = $type;
    }

update()

ilMMCustomItemFacade::update

(

)

Implements ilMMItemFacadeInterface.

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

References ilMMAbstractItemFacade\$default_title, getCustomStorage(), getType(), ilMMAbstractItemFacade\identification(), isCustom(), and League\Flysystem\Adapter\Polyfill\update().

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

Here is the call graph for this function:

Field Documentation

$action

ilMMCustomItemFacade::$action = ''

protected

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

Referenced by setAction().

$custom_item_storage

ilMMCustomItemFacade::$custom_item_storage

protected

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

$top_item

ilMMCustomItemFacade::$top_item = false

protected

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

Referenced by isTopItem(), and setIsTopItm().

$type

ilMMCustomItemFacade::$type = ''

protected

Definition at line 25 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