ilMMItemRepository Class Reference

Class ilMMItemRepository. More...

Collaboration diagram for ilMMItemRepository:

Public Member Functions
	__construct ()
	ilMMItemRepository constructor. More...
	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
ilGlobalCache	$cache
Services	$services
MainMenuMainCollector	$main_collector

Detailed Description

Class ilMMItemRepository.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilMMItemRepository::__construct

(

)

ilMMItemRepository constructor.

Exceptions

Throwable

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

References $DIC, ilGlobalCache\COMP_GLOBAL_SCREEN, ilGlobalCache\getInstance(), and ilMMItemStorage\register().

    {
        global $DIC;
        $this->cache = ilGlobalCache::getInstance(ilGlobalCache::COMP_GLOBAL_SCREEN);
        $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 66 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 270 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 279 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 126 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:

getItemFacade()

ilMMItemRepository::getItemFacade

(

IdentificationInterface

$identification = null

)

Parameters

IdentificationInterface | null

$identification

Returns

ilMMItemFacadeInterface

Exceptions

Throwable

Definition at line 166 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 183 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 190 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 211 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 232 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 75 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 80 of file class.ilMMItemRepository.php.

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

getSubItemsForTable()

ilMMItemRepository::getSubItemsForTable

(

)

Returns

array

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

References $data.

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 102 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 249 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 143 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:

repository()

ilMMItemRepository::repository

(

)

Returns

ilMMItemRepository

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

                                : ilMMItemRepository
    {
        return $this;
    }

resolveIdentificationFromString()

ilMMItemRepository::resolveIdentificationFromString

(

string

$identification_string

)

Definition at line 85 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 259 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

ilGlobalCache ilMMItemRepository::$cache

private

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

$db

ilDBInterface ilMMItemRepository::$db

private

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

$main_collector

MainMenuMainCollector ilMMItemRepository::$main_collector

private

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

$services

Services ilMMItemRepository::$services

private

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

---

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

• Services/MainMenu/classes/Items/class.ilMMItemRepository.php