ilMMCustomProvider Class Reference

Class ilMMCustomProvider. More...

Inheritance diagram for ilMMCustomProvider:

Collaboration diagram for ilMMCustomProvider:

Public Member Functions
	getSingleCustomItem (ilMMCustomItemStorage $storage, $register=false)
	provideTypeInformation ()
	@inheritDoc More...
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\MainMenu\Provider\AbstractStaticMainMenuProvider
	__construct (Container $dic)
	@inheritDoc More...
	getAllIdentifications ()
	@inheritDoc More...
	provideTypeInformation ()
	@inheritDoc More...
Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (Container $dic)
	@inheritDoc More...
	getFullyQualifiedClassName ()
	@inheritDoc More...
	getProviderNameForPresentation ()
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\MainMenu\Provider\StaticMainMenuProvider
	getStaticTopItems ()
	getStaticSubItems ()
	provideTypeInformation ()
	getAllIdentifications ()

Protected Attributes
	$dic
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\MainMenu\Provider\AbstractStaticMainMenuProvider
	$dic
	$if
	$mainmenu
Protected Attributes inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	$dic

Private Member Functions
	translateType (string $type)
	translateByline (string $type)

Additional Inherited Members
Data Fields inherited from ILIAS\GlobalScreen\Scope\MainMenu\Provider\StaticMainMenuProvider
const	PURPOSE_MAINBAR = 'mainmenu'
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()

Detailed Description

Class ilMMCustomProvider.

Author

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

Definition at line 24 of file class.ilMMCustomProvider.php.

Member Function Documentation

getSingleCustomItem()

ilMMCustomProvider::getSingleCustomItem	(	ilMMCustomItemStorage	$storage,
			$register = false
	)

Parameters

ilMMCustomItemStorage	$storage
bool	$register

Returns

\ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem

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

                                                                                           : \ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem
    {
        $identification = $this->globalScreen()->identification()->core($this)->identifier($storage->getIdentifier());
 
        if ($register) {
            ilGSIdentificationStorage::registerIdentification($identification, $this);
        }
 
        $item = $this->globalScreen()->mainmenu()->custom($storage->getType(), $identification);
 
        if ($item instanceof hasTitle && $storage->getDefaultTitle() !== '') {
            $item = $item->withTitle($storage->getDefaultTitle());
        }
        if ($item instanceof hasAction) {
            $item = $item->withAction("#");
        }
        if ($item instanceof isChild) {
            $mm_item = ilMMItemStorage::find($identification->serialize());
            $parent_identification = "";
            if ($mm_item instanceof ilMMItemStorage) {
                $parent_identification = $mm_item->getParentIdentification();
            }
 
            if ($parent_identification) {
                $item = $item->withParent(
                    $this->globalScreen()
                        ->identification()
                        ->fromSerializedIdentification($parent_identification)
                );
            }
        }
 
        if ($register) {
            ilMMItemStorage::register($item);
        }
 
        return $item;
    }

References CachedActiveRecord\find(), ilMMCustomItemStorage\getDefaultTitle(), ilMMCustomItemStorage\getIdentifier(), ilMMCustomItemStorage\getType(), ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), ilMMItemStorage\register(), and ilGSIdentificationStorage\registerIdentification().

Here is the call graph for this function:

provideTypeInformation()

ilMMCustomProvider::provideTypeInformation

(

)

@inheritDoc

Reimplemented from ILIAS\GlobalScreen\Scope\MainMenu\Provider\AbstractStaticMainMenuProvider.

Definition at line 116 of file class.ilMMCustomProvider.php.

                                             : TypeInformationCollection
    {
        $c = new TypeInformationCollection();
        $c->add(new TypeInformation(TopParentItem::class, $this->translateType(TopParentItem::class), new ilMMTopParentItemRenderer()));
        $c->add(new TypeInformation(TopLinkItem::class, $this->translateType(TopLinkItem::class), new ilMMTopLinkItemRenderer(), new ilMMTypeHandlerTopLink()));
        $c->add(new TypeInformation(Link::class, $this->translateType(Link::class), null, new ilMMTypeHandlerLink()));
        $link_list = new TypeInformation(LinkList::class, $this->translateType(LinkList::class));
        $link_list->setCreationPrevented(true);
        $c->add($link_list);
        $c->add(new TypeInformation(Separator::class, $this->translateType(Separator::class), null, new ilMMTypeHandlerSeparator(), $this->translateByline(Separator::class)));
        $c->add(new TypeInformation(RepositoryLink::class, $this->translateType(RepositoryLink::class), null, new ilMMTypeHandlerRepositoryLink()));
        $complex = new TypeInformation(Complex::class, $this->translateType(Complex::class));
        $complex->setCreationPrevented(true);
        $c->add($complex);
        $lost = new TypeInformation(Lost::class, $this->translateType(Lost::class), new ilMMLostItemRenderer());
        $lost->setCreationPrevented(true);
        $c->add($lost);
 
        return $c;
    }

References $c, translateByline(), and translateType().

Here is the call graph for this function:

translateByline()

ilMMCustomProvider::translateByline ( string  $type )

private

Parameters

string

$type

Returns

string

Definition at line 157 of file class.ilMMCustomProvider.php.

                                                   : string
    {
        $last_part = substr(strrchr($type, "\\"), 1);
        $last_part = strtolower(preg_replace('/(?<!^)[A-Z]/', '_$0', $last_part));
 
        return $this->dic->language()->txt("type_" . strtolower($last_part) . "_info");
    }

References $type.

Referenced by provideTypeInformation().

Here is the caller graph for this function:

translateType()

ilMMCustomProvider::translateType ( string  $type )

private

Parameters

string

$type

Returns

string

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

                                                 : string
    {
        $last_part = substr(strrchr($type, "\\"), 1);
        $last_part = strtolower(preg_replace('/(?<!^)[A-Z]/', '_$0', $last_part));
 
        return $this->dic->language()->txt("type_" . strtolower($last_part));
    }

References $type.

Referenced by provideTypeInformation().

Here is the caller graph for this function:

Field Documentation

$dic

ilMMCustomProvider::$dic

protected

Definition at line 30 of file class.ilMMCustomProvider.php.

---

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

• Services/MainMenu/classes/Provider/class.ilMMCustomProvider.php