Inheritance diagram for ilMMItemRepository:

Collaboration diagram for ilMMItemRepository:

Public Member Functions
	__construct ()
	ilMMItemRepository constructor. More...

	getContainerKey ()

	isForced ()

	clearCache ()

	getSingleItem (IdentificationInterface $identification)

	getSingleItemFromFilter (IdentificationInterface $identification)

	resolveIdentificationFromString (string $identification_string)

	repository ()

	getTopItems ()

	getLostItems ()

	getSubItemsForTable (?ilMMItemFacadeInterface $parent=null)

	flushLostItems ()

	hasLostItems ()

	getItemFacade (?IdentificationInterface $identification=null)

	getItemFacadesForIdentificationStrings (array $identifications)

	getItemFacadeForIdentificationString (string $identification)

	getPossibleParentsForFormAndTable ()

	getPossibleSubItemTypesWithInformation ()

	getPossibleTopItemTypesWithInformation (bool $new)

	getTypeHandlerForType (string $type)

	updateItem (ilMMItemFacadeInterface $item_facade)

	createItem (ilMMItemFacadeInterface $item_facade)

	deleteItem (ilMMItemFacadeInterface $item_facade)

	getContainerKey ()

	isForced ()

Private Attributes
ilDBInterface	$db

Services	$services

MainMenuMainCollector	$main_collector

Container	$cache

Detailed Description

Deprecated:

Author: Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 39 of file class.ilMMItemRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ilMMItemRepository::__construct ( )

ilMMItemRepository constructor.

Exceptions

Throwable

Definition at line 53 of file class.ilMMItemRepository.php.

    {
        global $DIC;
        $this->cache = $DIC->globalCache()->get($this);
        $this->db = $DIC->database();
        $this->main_collector = $DIC->globalScreen()->collector()->mainmenu();
        $this->main_collector->collectOnce();
        $this->services = $DIC->globalScreen();
 
        foreach ($this->main_collector->getRawUnfilteredItems() as $top_item) {
            ilMMItemStorage::register($top_item);
        }
    }

References $DIC, and ilMMItemStorage\register().

Here is the call graph for this function:

Member Function Documentation

◆ clearCache()

ilMMItemRepository::clearCache ( )

Definition at line 77 of file class.ilMMItemRepository.php.

                                : void
    {
        $this->cache->flush();
    }

Referenced by createItem(), deleteItem(), and updateItem().

Here is the caller graph for this function:

◆ createItem()

ilMMItemRepository::createItem ( ilMMItemFacadeInterface $item_facade )

Definition at line 286 of file class.ilMMItemRepository.php.

                                                                    : void
    {
        $item_facade->create();
        $this->clearCache();
    }

References clearCache(), and ilMMItemFacadeInterface\create().

Here is the call graph for this function:

◆ deleteItem()

ilMMItemRepository::deleteItem ( ilMMItemFacadeInterface $item_facade )

Definition at line 292 of file class.ilMMItemRepository.php.

                                                                    : void
    {
        if ($item_facade->isDeletable()) {
            $item_facade->delete();
            $this->clearCache();
        }
    }

References clearCache(), ilMMItemFacadeInterface\delete(), and ilMMItemFacadeInterface\isDeletable().

Here is the call graph for this function:

◆ flushLostItems()

ilMMItemRepository::flushLostItems ( )

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

                                    : void
    {
        foreach ($this->getLostItems() as $item) {
            $item_facade = $this->getItemFacade(
                $this->services->identification()->fromSerializedIdentification($item['identification'])
            );
            $item_facade->delete();
        }
    }

References getItemFacade(), and getLostItems().

Here is the call graph for this function:

◆ getContainerKey()

ilMMItemRepository::getContainerKey ( )

Implements ILIAS\Cache\Container\Request.

Definition at line 67 of file class.ilMMItemRepository.php.

                                     : string
    {
        return 'mm_items';
    }

◆ getItemFacade()

ilMMItemRepository::getItemFacade ( ?IdentificationInterface $identification = null )

Exceptions

Throwable

Definition at line 178 of file class.ilMMItemRepository.php.

                                                                                  : ilMMItemFacadeInterface
    {
        if ($identification === null || $identification instanceof NullIdentification || $identification instanceof NullPluginIdentification) {
            return new ilMMNullItemFacade($identification ?: new NullIdentification(), $this->main_collector);
        }
        if ($identification->getClassName() === CustomMainBarProvider::class) {
            return new ilMMCustomItemFacade($identification, $this->main_collector);
        }
 
        return new ilMMItemFacade($identification, $this->main_collector);
    }

Referenced by flushLostItems(), getItemFacadeForIdentificationString(), getItemFacadesForIdentificationStrings(), and getPossibleParentsForFormAndTable().

Here is the caller graph for this function:

◆ getItemFacadeForIdentificationString()

ilMMItemRepository::getItemFacadeForIdentificationString ( string $identification )

Exceptions

Throwable

Definition at line 204 of file class.ilMMItemRepository.php.

                                                                                : ilMMItemFacadeInterface
    {
        $id = $this->services->identification()->fromSerializedIdentification($identification);
 
        return $this->getItemFacade($id);
    }

References $id, and getItemFacade().

Here is the call graph for this function:

◆ getItemFacadesForIdentificationStrings()

ilMMItemRepository::getItemFacadesForIdentificationStrings ( array $identifications )

Definition at line 190 of file class.ilMMItemRepository.php.

                                                                                  : array
    {
        $item_facades = [];
        foreach ($identifications as $identification) {
            $id = $this->services->identification()->fromSerializedIdentification($identification);
            $item_facades[] = $this->getItemFacade($id);
        }
 
        return $item_facades;
    }

References $id, and getItemFacade().

Here is the call graph for this function:

◆ getLostItems()

ilMMItemRepository::getLostItems ( )

Definition at line 112 of file class.ilMMItemRepository.php.

                                  : array
    {
        $q = "SELECT sub_items.* " .
            "FROM il_mm_items AS sub_items " .
            "LEFT JOIN il_mm_items AS top_items ON top_items.identification = sub_items.parent_identification " .
            "WHERE sub_items.parent_identification != '' AND sub_items.parent_identification IS NOT NULL " .
            "AND (top_items.identification IS NULL OR top_items.identification = '') " .
            "ORDER BY top_items.position, parent_identification, sub_items.position ASC";
 
        $r = $this->db->query($q);
        $return = [];
        while ($data = $this->db->fetchAssoc($r)) {
            $return[] = $data;
        }
 
        return $return;
    }

References $data, and $q.

Referenced by flushLostItems(), and hasLostItems().

Here is the caller graph for this function:

◆ getPossibleParentsForFormAndTable()

ilMMItemRepository::getPossibleParentsForFormAndTable ( )

Definition at line 211 of file class.ilMMItemRepository.php.

                                                       : array
    {
        static $parents;
        if ($parents === null) {
            $parents = [];
            foreach (array_keys($this->getTopItems()) as $top_item_identification) {
                $identification = $this->services->identification()->fromSerializedIdentification(
                    $top_item_identification
                );
                $item = $this->getSingleItem($identification);
                if ($item instanceof TopParentItem) {
                    $parents[$top_item_identification] = $this->getItemFacade($identification)
                                                              ->getDefaultTitle();
                }
            }
        }
 
        return $parents;
    }

References getItemFacade(), getSingleItem(), and getTopItems().

Here is the call graph for this function:

◆ getPossibleSubItemTypesWithInformation()

ilMMItemRepository::getPossibleSubItemTypesWithInformation ( )

Returns: TypeInformation[]

Definition at line 234 of file class.ilMMItemRepository.php.

                                                            : array
    {
        $types = [];
        foreach ($this->main_collector->getTypeInformationCollection()->getAll() as $information) {
            if ($information->isCreationPrevented()) {
                continue;
            }
            if ($information->isChild()) {
                // since these two types are identical (more or less), we truncate one
                if ($information->getType() === TopLinkItem::class) {
                    continue;
                }
                $types[$information->getType()] = $information;
            }
        }
 
        return $types;
    }

◆ getPossibleTopItemTypesWithInformation()

ilMMItemRepository::getPossibleTopItemTypesWithInformation ( bool $new )

Returns: TypeInformation[]

Definition at line 256 of file class.ilMMItemRepository.php.

                                                                     : array
    {
        $types = [];
        foreach ($this->main_collector->getTypeInformationCollection()->getAll() as $information) {
            if (!$new || $information->isTop()) {
                $types[$information->getType()] = $information;
            }
        }
 
        return $types;
    }

◆ getSingleItem()

ilMMItemRepository::getSingleItem ( IdentificationInterface $identification )

Definition at line 82 of file class.ilMMItemRepository.php.

                                                                          : isItem
    {
        return $this->main_collector->getSingleItemFromRaw($identification);
    }

Referenced by getPossibleParentsForFormAndTable().

Here is the caller graph for this function:

◆ getSingleItemFromFilter()

ilMMItemRepository::getSingleItemFromFilter ( IdentificationInterface $identification )

Definition at line 87 of file class.ilMMItemRepository.php.

                                                                                    : isItem
    {
        return $this->main_collector->getSingleItemFromFilter($identification);
    }

◆ getSubItemsForTable()

ilMMItemRepository::getSubItemsForTable ( ?ilMMItemFacadeInterface $parent = null )

Definition at line 131 of file class.ilMMItemRepository.php.

                                                                                : array
    {
        if ($parent !== null) {
            $r = $this->db->queryF(
                "SELECT sub_items.*, top_items.position AS parent_position
FROM il_mm_items AS sub_items
LEFT JOIN il_mm_items AS top_items ON top_items.identification = sub_items.parent_identification
WHERE sub_items.parent_identification != '' AND sub_items.parent_identification = %s 
ORDER BY top_items.position, parent_identification, sub_items.position ASC",
                ['text'],
                [$parent->identification()->serialize()]
            );
        } else {
            $r = $this->db->query(
                "SELECT sub_items.*, top_items.position AS parent_position
FROM il_mm_items AS sub_items
LEFT JOIN il_mm_items AS top_items ON top_items.identification = sub_items.parent_identification
WHERE sub_items.parent_identification != ''  
ORDER BY top_items.position, parent_identification, sub_items.position ASC",
            );
        }
        $return = [];
        while ($data = $this->db->fetchAssoc($r)) {
            $return[] = $data;
        }
 
        return $return;
    }

References $data.

◆ getTopItems()

ilMMItemRepository::getTopItems ( )

Exceptions

arException

Definition at line 105 of file class.ilMMItemRepository.php.

                                 : array
    {
        return ilMMItemStorage::where(" parent_identification = '' OR parent_identification IS NULL ")->orderBy(
            'position'
        )->getArray();
    }

References ActiveRecord\where().

Referenced by getPossibleParentsForFormAndTable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTypeHandlerForType()

ilMMItemRepository::getTypeHandlerForType ( string $type )

Deprecated:

Definition at line 271 of file class.ilMMItemRepository.php.

                                                       : TypeHandler
    {
        $item = $this->services->mainBar()->custom($type, new NullIdentification());
 
        return $this->main_collector->getTypeHandlerForItem($item);
    }

◆ hasLostItems()

ilMMItemRepository::hasLostItems ( )

Definition at line 170 of file class.ilMMItemRepository.php.

                                  : bool
    {
        return count($this->getLostItems()) > 0;
    }

References getLostItems().

Here is the call graph for this function:

◆ isForced()

ilMMItemRepository::isForced ( )

Implements ILIAS\Cache\Container\Request.

Definition at line 72 of file class.ilMMItemRepository.php.

                              : bool
    {
        return false;
    }

◆ repository()

ilMMItemRepository::repository ( )

Definition at line 97 of file class.ilMMItemRepository.php.

                                : ilMMItemRepository
    {
        return $this;
    }

◆ resolveIdentificationFromString()

ilMMItemRepository::resolveIdentificationFromString ( string $identification_string )

Definition at line 92 of file class.ilMMItemRepository.php.

                                                                                  : IdentificationInterface
    {
        return $this->services->identification()->fromSerializedIdentification($identification_string);
    }

◆ updateItem()

ilMMItemRepository::updateItem ( ilMMItemFacadeInterface $item_facade )

Definition at line 278 of file class.ilMMItemRepository.php.

                                                                    : void
    {
        if ($item_facade->isEditable()) {
            $item_facade->update();
            $this->clearCache();
        }
    }

References clearCache(), ilMMItemFacadeInterface\isEditable(), and ilMMItemFacadeInterface\update().

Here is the call graph for this function:

Field Documentation

◆ $cache

Container ilMMItemRepository::$cache

private

Definition at line 47 of file class.ilMMItemRepository.php.

◆ $db

ilDBInterface ilMMItemRepository::$db

private

Definition at line 41 of file class.ilMMItemRepository.php.

◆ $main_collector

MainMenuMainCollector ilMMItemRepository::$main_collector

private

Definition at line 45 of file class.ilMMItemRepository.php.

◆ $services

Services ilMMItemRepository::$services

private

Definition at line 43 of file class.ilMMItemRepository.php.

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

components/ILIAS/MainMenu/classes/Items/class.ilMMItemRepository.php

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clearCache()

◆ createItem()

◆ deleteItem()

◆ flushLostItems()

◆ getContainerKey()

◆ getItemFacade()

◆ getItemFacadeForIdentificationString()

◆ getItemFacadesForIdentificationStrings()

◆ getLostItems()

◆ getPossibleParentsForFormAndTable()

◆ getPossibleSubItemTypesWithInformation()

◆ getPossibleTopItemTypesWithInformation()

◆ getSingleItem()

◆ getSingleItemFromFilter()

◆ getSubItemsForTable()

◆ getTopItems()

◆ getTypeHandlerForType()

◆ hasLostItems()

◆ isForced()

◆ repository()

◆ resolveIdentificationFromString()

◆ updateItem()

Field Documentation

◆ $cache

◆ $db

◆ $main_collector

◆ $services