ilMMItemRepository Class Reference

Class ilMMItemRepository. More...

Collaboration diagram for ilMMItemRepository:

Public Member Functions
	__construct ()
	ilMMItemRepository constructor. More...
	getEmptyItemForTypeString (string $class_name)
	clearCache ()
	getStackedTopItemsForPresentation ()
	getSingleItem (IdentificationInterface $identification)
	repository ()
	getTopItems ()
	getSubItemsForTable ()
	flushLostItems ()
	hasLostItems ()
	getItemFacade (IdentificationInterface $identification=null)
	getItemFacadeForIdentificationString (string $identification)
	getPossibleParentsForFormAndTable ()
	getPossibleSubItemTypesForForm ()
	getPossibleSubItemTypesWithInformation ()
	getPossibleTopItemTypesForForm ()
	getPossibleTopItemTypesWithInformation ()
	getTypeHandlerForType (string $type)
	updateItem (ilMMItemFacadeInterface $item_facade)
	createItem (ilMMItemFacadeInterface $item_facade)
	deleteItem (ilMMItemFacadeInterface $item_facade)

Private Member Functions
	sync ()

Private Attributes
	$services
	$synced = false
	$storage
	$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 20 of file class.ilMMItemRepository.php.

Constructor & Destructor Documentation

__construct()

ilMMItemRepository::__construct

(

)

ilMMItemRepository constructor.

Exceptions

Throwable

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

References $DIC, ilMMItemStorage\register(), and sync().

    {
        global $DIC;
        $this->storage = new CoreStorageFacade();
        $this->main_collector = $DIC->globalScreen()->collector()->mainmenu();
        $this->services = $DIC->globalScreen();

        foreach ($this->main_collector->getStackedTopItemsForPresentation() as $top_item) {
            ilMMItemStorage::register($top_item);
            if ($top_item instanceof isParent) {
                foreach ($top_item->getChildren() as $child) {
                    ilMMItemStorage::register($child);
                }
            }
        }
        $this->sync();
    }

Here is the call graph for this function:

Member Function Documentation

clearCache()

ilMMItemRepository::clearCache

(

)

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

    {
        $this->storage->cache()->flush();
    }

createItem()

ilMMItemRepository::createItem

(

ilMMItemFacadeInterface

$item_facade

)

Parameters

ilMMItemFacadeInterface

$item_facade

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

References ilMMItemFacadeInterface\create().

    {
        $item_facade->create();
        $this->storage->cache()->flush();
    }

Here is the call graph for this function:

deleteItem()

ilMMItemRepository::deleteItem

(

ilMMItemFacadeInterface

$item_facade

)

Parameters

ilMMItemFacadeInterface

$item_facade

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

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

    {
        if ($item_facade->isDeletable()) {
            $item_facade->delete();
            $this->storage->cache()->flush();
        }
    }

Here is the call graph for this function:

flushLostItems()

ilMMItemRepository::flushLostItems

(

)

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

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

    {
        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:

getEmptyItemForTypeString()

ilMMItemRepository::getEmptyItemForTypeString

(

string

$class_name

)

Parameters

string

$class_name

Returns

isItem

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

                                                                  : isItem
    {
        return $this->services->mainmenu()->custom($class_name, new  NullIdentification());
    }

getItemFacade()

ilMMItemRepository::getItemFacade

(

IdentificationInterface

$identification = null

)

Parameters

IdentificationInterface | null

$identification

Returns

ilMMItemFacadeInterface

Exceptions

Throwable

Definition at line 208 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 ? $identification : new NullIdentification(), $this->main_collector);
        }
        if ($identification->getClassName() === ilMMCustomProvider::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 227 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 235 of file class.ilMMItemRepository.php.

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

                                                        : array
    {
        static $parents;
        if (is_null($parents)) {
            $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:

getPossibleSubItemTypesForForm()

ilMMItemRepository::getPossibleSubItemTypesForForm

(

)

Returns

array

See also

getPossibleSubItemTypesWithInformation

Deprecated:

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

                                                     : array
    {
        $types = [];
        foreach ($this->main_collector->getTypeInformationCollection()->getAll() as $information) {
            if ($information->isCreationPrevented()) {
                continue;
            }
            if ($information->isChild()) {
                $types[$information->getType()] = $information->getTypeNameForPresentation();
            }
        }

        return $types;
    }

getPossibleSubItemTypesWithInformation()

ilMMItemRepository::getPossibleSubItemTypesWithInformation

(

)

Returns

[]

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

                                                             : array
    {
        $types = [];
        foreach ($this->main_collector->getTypeInformationCollection()->getAll() as $information) {
            if ($information->isCreationPrevented()) {
                continue;
            }
            if ($information->isChild()) {
                $types[$information->getType()] = $information;
            }
        }

        return $types;
    }

getPossibleTopItemTypesForForm()

ilMMItemRepository::getPossibleTopItemTypesForForm

(

)

Returns

array

See also

getPossibleTopItemTypesWithInformation

Deprecated:

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

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

        return $types;
    }

getPossibleTopItemTypesWithInformation()

ilMMItemRepository::getPossibleTopItemTypesWithInformation

(

)

Returns

[]

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

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

        return $types;
    }

getSingleItem()

ilMMItemRepository::getSingleItem

(

IdentificationInterface

$identification

)

Parameters

IdentificationInterface

$identification

Returns

isItem

Exceptions

Throwable

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

Referenced by getPossibleParentsForFormAndTable().

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

Here is the caller graph for this function:

getStackedTopItemsForPresentation()

ilMMItemRepository::getStackedTopItemsForPresentation

(

)

Returns

TopLinkItem[]|TopParentItem[]

Exceptions

Throwable

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

                                                        : array
    {
        $top_items = $this->main_collector->getStackedTopItemsForPresentation();

        return $top_items;
    }

getSubItemsForTable()

ilMMItemRepository::getSubItemsForTable

(

)

Returns

array

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

References $data, and $r.

Referenced by flushLostItems(), and hasLostItems().

                                          : array
    {
        $r = $this->storage->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->storage->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 141 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 336 of file class.ilMMItemRepository.php.

                                                        : TypeHandler
    {
        $item = $this->services->mainmenu()->custom($type, new NullIdentification());

        return $this->main_collector->getHandlerForItem($item);
    }

hasLostItems()

ilMMItemRepository::hasLostItems

(

)

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

                                 : ilMMItemRepository
    {
        return $this;
    }

sync()

ilMMItemRepository::sync ( )

private

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

References PHPMailer\PHPMailer\$provider, $synced, ilPluginAdmin\getAllGlobalScreenProviders(), and ilGSIdentificationStorage\registerIdentification().

Referenced by __construct().

                            : bool
    {
        if ($this->synced === false || $this->synced === null) {
            foreach (ilPluginAdmin::getAllGlobalScreenProviders() as $provider) {
                foreach ($provider->getAllIdentifications() as $identification) {
                    ilGSIdentificationStorage::registerIdentification($identification, $provider);
                }
            }

            $this->storage->db()->manipulate(
                "DELETE FROM il_mm_items 
                                                WHERE EXISTS (SELECT null FROM il_gs_identifications 
                                                              WHERE il_gs_identifications.identification = il_mm_items.identification 
                                                      AND il_gs_identifications.identification IS NULL)"
            );
            $this->synced = true;
        }

        return $this->synced;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateItem()

ilMMItemRepository::updateItem

(

ilMMItemFacadeInterface

$item_facade

)

Parameters

ilMMItemFacadeInterface

$item_facade

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

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

    {
        if ($item_facade->isEditable()) {
            $item_facade->update();
            $this->storage->cache()->flush();
        }
    }

Here is the call graph for this function:

Field Documentation

$main_collector

ilMMItemRepository::$main_collector

private

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

$services

ilMMItemRepository::$services

private

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

$storage

ilMMItemRepository::$storage

private

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

$synced

ilMMItemRepository::$synced = false

private

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

Referenced by sync().

---

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

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