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)
	getSingleCustomItem (ilMMCustomItemStorage $storage, $register=false)
	provideTypeInformation ()
	getProviderNameForPresentation ()
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\MainMenu\Provider\AbstractStaticMainMenuProvider
	__construct (Container $dic)
	getAllIdentifications ()
	provideTypeInformation ()
Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (Container $dic)
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\MainMenu\Provider\StaticMainMenuProvider
	getStaticTopItems ()
	getStaticSubItems ()

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)

Private Attributes
	$access_helper
	$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 39 of file CustomMainBarProvider.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MainMenu\Provider\CustomMainBarProvider::__construct

(

Container

$dic

)

Definition at line 58 of file CustomMainBarProvider.php.

References ILIAS\GlobalScreen\Provider\__construct(), ILIAS\GlobalScreen\Helper\BasicAccessCheckClosures\getInstance(), ILIAS\MainMenu\Provider\CustomMainBarProvider\getSingleCustomItem(), ILIAS\GlobalScreen\Scope\MainMenu\Provider\StaticMainMenuProvider\getStaticSubItems(), ILIAS\GlobalScreen\Scope\MainMenu\Provider\StaticMainMenuProvider\getStaticTopItems(), and ActiveRecord\where().

    {
        parent::__construct($dic);
        $this->mm_access = new ilObjMainMenuAccess();
        $this->access_helper = BasicAccessCheckClosures::getInstance();
    }

Here is the call graph for this function:

Member Function Documentation

getProviderNameForPresentation()

ILIAS\MainMenu\Provider\CustomMainBarProvider::getProviderNameForPresentation

(

)

Implements ILIAS\GlobalScreen\Provider\Provider.

Definition at line 240 of file CustomMainBarProvider.php.

                                                     : string
    {
        return "Custom";
    }

getSingleCustomItem()

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

Parameters

ilMMCustomItemStorage	$storage
bool	$register

Returns

isItem

Definition at line 102 of file CustomMainBarProvider.php.

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

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

                                                                                           : isItem
    {
        $identification = $this->globalScreen()->identification()->core($this)->identifier($storage->getIdentifier());

        $item = $this->globalScreen()->mainBar()->custom($storage->getType(), $identification)->withVisibilityCallable(
            $this->mm_access->isCurrentUserAllowedToSeeCustomItem($storage)
        );

        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) {
                $item = $item->withParent(
                    $this->globalScreen()
                         ->identification()
                         ->fromSerializedIdentification($parent_identification)
                );
            }
        }

        if ($register) {
            ilMMItemStorage::register($item);
        }

        return $item;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

provideTypeInformation()

ILIAS\MainMenu\Provider\CustomMainBarProvider::provideTypeInformation

(

)

Implements ILIAS\GlobalScreen\Scope\MainMenu\Provider\StaticMainMenuProvider.

Definition at line 142 of file CustomMainBarProvider.php.

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

                                             : 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;
    }

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 229 of file CustomMainBarProvider.php.

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

                                                   : 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");
    }

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 217 of file CustomMainBarProvider.php.

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

                                                 : 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));
    }

Here is the caller graph for this function:

Field Documentation

$access_helper

ILIAS\MainMenu\Provider\CustomMainBarProvider::$access_helper

private

Definition at line 45 of file CustomMainBarProvider.php.

$dic

ILIAS\MainMenu\Provider\CustomMainBarProvider::$dic

protected

Definition at line 53 of file CustomMainBarProvider.php.

$mm_access

ILIAS\MainMenu\Provider\CustomMainBarProvider::$mm_access

private

Definition at line 49 of file CustomMainBarProvider.php.

---

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

• Services/MainMenu/classes/Provider/CustomMainBarProvider.php