ilMMNullItemFacade Class Reference

Class ilMMNullItemFacade. More...

Inheritance diagram for ilMMNullItemFacade:

Collaboration diagram for ilMMNullItemFacade:

Public Member Functions
	__construct (IdentificationInterface $identification, Main $collector)
	@inheritDoc More...
	isTopItem ()
	@inheritDoc More...
	setIsTopItm (bool $top_item)
	@inheritDoc More...
	isEmpty ()
	@inheritDoc More...
	setActiveStatus (bool $status)
	@inheritDoc More...
	setParent (string $parent)
	@inheritDoc More...
	create ()
	isAvailable ()
	isAlwaysAvailable ()
	@inheritDoc More...
	getProviderNameForPresentation ()
	@inheritDoc More...
	isDeletable ()
	@inheritDoc More...
	delete ()
	@inheritDoc More...
	supportsRoleBasedVisibility ()
	@inheritDoc More...
Public Member Functions inherited from ilMMCustomItemFacade
	__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
	$top_item = false
Protected Attributes inherited from ilMMCustomItemFacade
	$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 Attributes
	$parent_identification = ""
	$active_status

Additional Inherited Members
Protected Member Functions inherited from ilMMAbstractItemFacade
	deleteAssociatedTranslations ()
	deletes all translations associated with the current identification. More...

Detailed Description

Class ilMMNullItemFacade.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 12 of file class.ilMMNullItemFacade.php.

Constructor & Destructor Documentation

__construct()

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

@inheritDoc

Reimplemented from ilMMCustomItemFacade.

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

    {
        $this->identification = $identification;
        parent::__construct($identification, $collector);
    }

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

Here is the call graph for this function:

Member Function Documentation

create()

ilMMNullItemFacade::create

(

)

Returns

void

Implements ilMMItemFacadeInterface.

Definition at line 84 of file class.ilMMNullItemFacade.php.

    {
        $s = new ilMMCustomItemStorage();
        $s->setIdentifier(uniqid());
        $s->setType($this->type);
        $s->setTopItem($this->isTopItem());
        $s->setAction($this->action);
        $s->setDefaultTitle($this->default_title);
        $s->create();
 
        $this->custom_item_storage = $s;
 
        global $DIC;
        $provider = new CustomMainBarProvider($DIC);
        $this->raw_item = $provider->getSingleCustomItem($s);
        if ($this->parent_identification && $this->raw_item instanceof \ILIAS\GlobalScreen\Scope\MainMenu\Factory\isChild) {
            global $DIC;
            $this->raw_item = $this->raw_item->withParent($DIC->globalScreen()->identification()->fromSerializedIdentification($this->parent_identification));
        }
 
        $this->identification = $this->raw_item->getProviderIdentification();
 
        $this->mm_item = new ilMMItemStorage();
        $this->mm_item->setPosition(9999999); // always the last on the top item
        $this->mm_item->setIdentification($this->raw_item->getProviderIdentification()->serialize());
        $this->mm_item->setParentIdentification($this->parent_identification);
        $this->mm_item->setActive($this->active_status);
        if ($this->raw_item instanceof \ILIAS\GlobalScreen\Scope\MainMenu\Factory\isChild) {
            $this->mm_item->setParentIdentification($this->raw_item->getParent()->serialize());
        }
 
        parent::create();
    }

References $DIC, ilMMItemFacadeInterface\identification(), ilMMItemFacadeInterface\isChild(), and isTopItem().

Here is the call graph for this function:

delete()

ilMMNullItemFacade::delete

(

)

@inheritDoc

Reimplemented from ilMMCustomItemFacade.

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

    {
        parent::delete();
    }

getProviderNameForPresentation()

ilMMNullItemFacade::getProviderNameForPresentation

(

)

@inheritDoc

Reimplemented from ilMMCustomItemFacade.

Definition at line 137 of file class.ilMMNullItemFacade.php.

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

References ilMMItemFacadeInterface\identification().

Here is the call graph for this function:

isAlwaysAvailable()

ilMMNullItemFacade::isAlwaysAvailable

(

)

@inheritDoc

Implements ilMMItemFacadeInterface.

Definition at line 128 of file class.ilMMNullItemFacade.php.

                                        : bool
    {
        return false;
    }

isAvailable()

ilMMNullItemFacade::isAvailable

(

)

Returns

bool

Implements ilMMItemFacadeInterface.

Definition at line 119 of file class.ilMMNullItemFacade.php.

                                  : bool
    {
        return false;
    }

isDeletable()

ilMMNullItemFacade::isDeletable

(

)

@inheritDoc

Reimplemented from ilMMCustomItemFacade.

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

                                  : bool
    {
        return true;
    }

isEmpty()

ilMMNullItemFacade::isEmpty

(

)

@inheritDoc

Implements ilMMItemFacadeInterface.

Definition at line 60 of file class.ilMMNullItemFacade.php.

                              : bool
    {
        return true;
    }

isTopItem()

ilMMNullItemFacade::isTopItem

(

)

@inheritDoc

Reimplemented from ilMMCustomItemFacade.

Definition at line 42 of file class.ilMMNullItemFacade.php.

                                : bool
    {
        return $this->top_item;
    }

References $top_item.

Referenced by create().

Here is the caller graph for this function:

setActiveStatus()

ilMMNullItemFacade::setActiveStatus

(

bool

$status

)

@inheritDoc

Implements ilMMItemFacadeInterface.

Definition at line 69 of file class.ilMMNullItemFacade.php.

    {
        $this->active_status = $status;
    }

setIsTopItm()

ilMMNullItemFacade::setIsTopItm

(

bool

$top_item

)

@inheritDoc

Reimplemented from ilMMCustomItemFacade.

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

    {
        $this->top_item = $top_item;
    }

References $top_item.

setParent()

ilMMNullItemFacade::setParent

(

string

$parent

)

@inheritDoc

Implements ilMMItemFacadeInterface.

Definition at line 78 of file class.ilMMNullItemFacade.php.

    {
        $this->parent_identification = $parent;
    }

supportsRoleBasedVisibility()

ilMMNullItemFacade::supportsRoleBasedVisibility

(

)

@inheritDoc

Reimplemented from ilMMCustomItemFacade.

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

                                                  : bool
    {
        return true;
    }

Field Documentation

$active_status

ilMMNullItemFacade::$active_status

private

Definition at line 22 of file class.ilMMNullItemFacade.php.

$parent_identification

ilMMNullItemFacade::$parent_identification = ""

private

Definition at line 18 of file class.ilMMNullItemFacade.php.

$top_item

ilMMNullItemFacade::$top_item = false

protected

Definition at line 26 of file class.ilMMNullItemFacade.php.

Referenced by isTopItem(), and setIsTopItm().

---

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

• Services/MainMenu/classes/Items/Facade/class.ilMMNullItemFacade.php