ILIAS\MainMenu\Provider\CustomMainBarProvider Class Reference

Class CustomMainBarProvider. More...

Inheritance diagram for ILIAS\MainMenu\Provider\CustomMainBarProvider:

Collaboration diagram for ILIAS\MainMenu\Provider\CustomMainBarProvider:

Public Member Functions
	__construct (Container $dic, ?\ilMainMenuAccess $access=null)
	@inheritDoc More...
	getSingleCustomItem (ilMMCustomItemStorage $storage, bool $register=false)
	provideTypeInformation ()
	@inheritDoc More...
	getProviderNameForPresentation ()
	@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 (protected Container $dic)
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\MainMenu\Provider\StaticMainMenuProvider
	getStaticTopItems ()
	getStaticSubItems ()
	provideTypeInformation ()
	getAllIdentifications ()

Protected Attributes
Container	$dic
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\MainMenu\Provider\AbstractStaticMainMenuProvider
Container	$dic
IdentificationProviderInterface	$if
MainMenuItemFactory	$mainmenu

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

Private Attributes
ilMainMenuAccess	$mm_access

Additional Inherited Members
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()

Detailed Description

Class CustomMainBarProvider.

Author

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

Definition at line 60 of file CustomMainBarProvider.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MainMenu\Provider\CustomMainBarProvider::__construct	(	Container	$dic,
		?\ilMainMenuAccess	$access = null
	)

@inheritDoc

Definition at line 68 of file CustomMainBarProvider.php.

    {
        parent::__construct($dic);
        $this->mm_access = $access ?? new ilObjMainMenuAccess();
    }

References ILIAS\MainMenu\Provider\CustomMainBarProvider\$dic, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

getProviderNameForPresentation()

ILIAS\MainMenu\Provider\CustomMainBarProvider::getProviderNameForPresentation

(

)

@inheritDoc

Reimplemented from ILIAS\GlobalScreen\Provider\AbstractProvider.

Definition at line 266 of file CustomMainBarProvider.php.

                                                    : string
    {
        return "Custom";
    }

getSingleCustomItem()

ILIAS\MainMenu\Provider\CustomMainBarProvider::getSingleCustomItem	(	ilMMCustomItemStorage	$storage,
		bool	$register = false
	)

Parameters

ilMMCustomItemStorage	$storage
bool	$register

Returns

isItem

Definition at line 111 of file CustomMainBarProvider.php.

                                                                                               : isItem
    {
        $identification = $this->globalScreen()->identification()->core($this)->identifier($storage->getIdentifier());
 
        $item = $this->globalScreen()->mainBar()->custom($storage->getType(), $identification);
 
        $item = $item->withVisibilityCallable(
            $this->mm_access->isCurrentUserAllowedToSeeCustomItem(
                $storage,
                fn(): bool => $item->isVisible()
            )
        );
 
        if ($item instanceof hasTitle && !empty($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 !== '' && $parent_identification !== '0') {
                $item = $item->withParent(
                    $this->globalScreen()
                         ->identification()
                         ->fromSerializedIdentification($parent_identification)
                );
            }
        }
 
        if ($register) {
            ilMMItemStorage::register($item);
        }
 
        return $item;
    }

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

Here is the call graph for this function:

provideTypeInformation()

ILIAS\MainMenu\Provider\CustomMainBarProvider::provideTypeInformation

(

)

@inheritDoc

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

Definition at line 157 of file CustomMainBarProvider.php.

                                            : TypeInformationCollection
    {
        $c = new TypeInformationCollection();
        // TopParentItem
        $c->add(
            new TypeInformation(
                TopParentItem::class,
                $this->translateType(TopParentItem::class),
                new TopParentItemRenderer()
            )
        );
        // TopLinkItem
        $c->add(
            new TypeInformation(
                TopLinkItem::class,
                $this->translateType(TopLinkItem::class),
                new ilMMTopLinkItemRenderer(),
                new ilMMTypeHandlerTopLink()
            )
        );
        // Link
        $c->add(
            new TypeInformation(
                Link::class,
                $this->translateType(Link::class),
                new ilMMLinkItemRenderer(),
                new ilMMTypeHandlerLink()
            )
        );
 
        // LinkList
        $link_list = new TypeInformation(
            LinkList::class,
            $this->translateType(LinkList::class),
            new LinkListItemRenderer()
        );
        $link_list->setCreationPrevented(true);
        $c->add($link_list);
 
        // Separator
        $c->add(
            new TypeInformation(
                Separator::class,
                $this->translateType(Separator::class),
                new SeparatorItemRenderer(),
                new ilMMTypeHandlerSeparator(),
                $this->translateByline(Separator::class)
            )
        );
 
        // RepositoryLink
        $c->add(
            new TypeInformation(
                RepositoryLink::class,
                $this->translateType(RepositoryLink::class),
                new ilMMRepositoryLinkItemRenderer(),
                new ilMMTypeHandlerRepositoryLink()
            )
        );
 
        // Lost
        $lost = new TypeInformation(
            Lost::class,
            $this->translateType(Lost::class),
            new LostItemRenderer()
        );
        $lost->setCreationPrevented(true);
        $c->add($lost);
 
        // Complex
        $complex = new TypeInformation(
            Complex::class,
            $this->translateType(Complex::class),
            new ComplexItemRenderer()
        );
        $complex->setCreationPrevented(true);
        $c->add($complex);
 
        return $c;
    }

References $c, ILIAS\MainMenu\Provider\CustomMainBarProvider\translateByline(), and ILIAS\MainMenu\Provider\CustomMainBarProvider\translateType().

Here is the call graph for this function:

translateByline()

ILIAS\MainMenu\Provider\CustomMainBarProvider::translateByline ( string  $type )

private

Parameters

string

$type

Returns

string

Definition at line 254 of file CustomMainBarProvider.php.

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

Referenced by ILIAS\MainMenu\Provider\CustomMainBarProvider\provideTypeInformation().

Here is the caller graph for this function:

translateType()

ILIAS\MainMenu\Provider\CustomMainBarProvider::translateType ( string  $type )

private

Parameters

string

$type

Returns

string

Definition at line 242 of file CustomMainBarProvider.php.

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

Referenced by ILIAS\MainMenu\Provider\CustomMainBarProvider\provideTypeInformation().

Here is the caller graph for this function:

Field Documentation

$dic

Container ILIAS\MainMenu\Provider\CustomMainBarProvider::$dic

protected

Definition at line 63 of file CustomMainBarProvider.php.

Referenced by ILIAS\MainMenu\Provider\CustomMainBarProvider\__construct().

$mm_access

ilMainMenuAccess ILIAS\MainMenu\Provider\CustomMainBarProvider::$mm_access

private

Definition at line 62 of file CustomMainBarProvider.php.

---

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

• components/ILIAS/MainMenu/classes/Provider/CustomMainBarProvider.php