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 ()

	getSubItemsForTable ()

	flushLostItems ()

	hasLostItems ()

	getItemFacade (IdentificationInterface $identification=null)

	getItemFacadeForIdentificationString (string $identification)

	getPossibleParentsForFormAndTable ()

	getPossibleSubItemTypesWithInformation ()

	getPossibleTopItemTypesWithInformation (bool $new)

	getTypeHandlerForType (string $type)

	updateItem (ilMMItemFacadeInterface $item_facade)

	createItem (ilMMItemFacadeInterface $item_facade)

	deleteItem (ilMMItemFacadeInterface $item_facade)

Private Attributes
ilDBInterface	$db

Services	$services

MainMenuMainCollector	$main_collector

ILIAS Cache Container Container	$cache

Detailed Description

Class ilMMItemRepository.

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

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.

References $DIC, and ilMMItemStorage\register().

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

Here is the call graph for this function:

Member Function Documentation

◆ clearCache()

ilMMItemRepository::clearCache ( )

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

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

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

Here is the caller graph for this function:

◆ createItem()

ilMMItemRepository::createItem ( ilMMItemFacadeInterface $item_facade )

Parameters

ilMMItemFacadeInterface $item_facade

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

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

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

Here is the call graph for this function:

◆ deleteItem()

ilMMItemRepository::deleteItem ( ilMMItemFacadeInterface $item_facade )

Parameters

ilMMItemFacadeInterface $item_facade

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

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

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

Here is the call graph for this function:

◆ flushLostItems()

ilMMItemRepository::flushLostItems ( )

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

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

                                     : void
     {
         foreach ($this->getTopItems() as $item) {
             $item_facade = $this->getItemFacade($this->services->identification()->fromSerializedIdentification($item['identification']));
             if (Lost::class === $item_facade->getType()) {
                 $item_facade->delete();
             }
         }
 
         foreach ($this->getSubItemsForTable() as $item) {
             $item_facade = $this->getItemFacade($this->services->identification()->fromSerializedIdentification($item['identification']));
             if (Lost::class === $item_facade->getType()) {
                 $item_facade->delete();
             }
         }
     }

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 )

Parameters

IdentificationInterface | null $identification

Returns: ilMMItemFacadeInterface

Exceptions

Throwable

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

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

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

Here is the caller graph for this function:

◆ getItemFacadeForIdentificationString()

ilMMItemRepository::getItemFacadeForIdentificationString ( string $identification )

Parameters

string $identification

Returns: ilMMItemFacadeInterface

Exceptions

Throwable

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

References $id, and getItemFacade().

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

Here is the call graph for this function:

◆ getPossibleParentsForFormAndTable()

ilMMItemRepository::getPossibleParentsForFormAndTable ( )

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

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

                                                        : array
     {
         static $parents;
         if ($parents === null) {
             $parents = [];
             foreach ($this->getTopItems() as $top_item_identification => $data) {
                 $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;
     }

Here is the call graph for this function:

◆ getPossibleSubItemTypesWithInformation()

ilMMItemRepository::getPossibleSubItemTypesWithInformation ( )

Returns: []

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

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

◆ getPossibleTopItemTypesWithInformation()

ilMMItemRepository::getPossibleTopItemTypesWithInformation ( bool $new )

Returns: []

Definition at line 244 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 )

Parameters

IdentificationInterface $identification

Returns: isItem

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

Referenced by getPossibleParentsForFormAndTable().

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

Here is the caller graph for this function:

◆ getSingleItemFromFilter()

ilMMItemRepository::getSingleItemFromFilter ( IdentificationInterface $identification )

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

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

◆ getSubItemsForTable()

ilMMItemRepository::getSubItemsForTable ( )

Returns: array

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

References $data, and $r.

Referenced by flushLostItems(), and hasLostItems().

                                          : array
     {
         $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;
     }

Here is the caller graph for this function:

◆ getTopItems()

ilMMItemRepository::getTopItems ( )

Returns: array

Exceptions

arException

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

References ActiveRecord\where().

Referenced by flushLostItems(), getPossibleParentsForFormAndTable(), and hasLostItems().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTypeHandlerForType()

ilMMItemRepository::getTypeHandlerForType ( string $type )

Parameters

string $type

Returns: TypeHandler

Deprecated:

Definition at line 261 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 155 of file class.ilMMItemRepository.php.

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

                                   : bool
     {
         foreach ($this->getTopItems() as $item) {
             $item_facade = $this->getItemFacade($this->services->identification()->fromSerializedIdentification($item['identification']));
             if (Lost::class === $item_facade->getType()) {
                 return true;
             }
         }
 
         foreach ($this->getSubItemsForTable() as $item) {
             $item_facade = $this->getItemFacade($this->services->identification()->fromSerializedIdentification($item['identification']));
             if (Lost::class === $item_facade->getType()) {
                 return true;
             }
         }
         return false;
     }

Here is the call graph for this function:

◆ isForced()

ilMMItemRepository::isForced ( )

Implements ILIAS\Cache\Container\Request.

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

                               : bool
     {
         return false;
     }

◆ repository()

ilMMItemRepository::repository ( )

Returns: ilMMItemRepository

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

                                 : ilMMItemRepository
     {
         return $this;
     }

◆ resolveIdentificationFromString()

ilMMItemRepository::resolveIdentificationFromString ( string $identification_string )

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

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

◆ updateItem()

ilMMItemRepository::updateItem ( ilMMItemFacadeInterface $item_facade )

Parameters

ilMMItemFacadeInterface $item_facade

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

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

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

Here is the call graph for this function:

Field Documentation

◆ $cache

ILIAS Cache Container 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()

◆ getPossibleParentsForFormAndTable()

◆ getPossibleSubItemTypesWithInformation()

◆ getPossibleTopItemTypesWithInformation()

◆ getSingleItem()

◆ getSingleItemFromFilter()

◆ getSubItemsForTable()

◆ getTopItems()

◆ getTypeHandlerForType()

◆ hasLostItems()

◆ isForced()

◆ repository()

◆ resolveIdentificationFromString()

◆ updateItem()

Field Documentation

◆ $cache

◆ $db

◆ $main_collector

◆ $services