Inheritance diagram for ilMMItemStorage:

Collaboration diagram for ilMMItemStorage:

Public Member Functions
	create ()

	getCache ()
	@inheritDoc More...

	getIdentification ()

	setIdentification (string $identification)

	isActive ()

	setActive (bool $active)

	getPosition ()

	setPosition (int $position)

	getParentIdentification ()

	setParentIdentification (string $parent_identification)

	getIconId ()

	setIconId (string $icon_id)

Public Member Functions inherited from CachedActiveRecord
	getCache ()

	getCacheIdentifier ()

	getTTL ()

	__construct ($primary_key=0, arConnector $connector=null)
	@inheritDoc More...

	afterObjectLoad ()

	storeObjectToCache ()

	buildFromArray (array $array)
	@inheritDoc More...

	store ()

	save ()

	create ()

	copy ($new_id=0)
	@inheritDoc More...

	read ()

	update ()

	delete ()

Public Member Functions inherited from ActiveRecord
	getArConnector ()

	getArFieldList ()

	getConnectorContainerName ()

	setConnectorContainerName ($connector_container_name)

	getPrimaryFieldValue ()

	setPrimaryFieldValue ($value)

	__construct ($primary_key=0, arConnector $connector=null)

	storeObjectToCache ()

	__getConvertedDateFieldsAsArray ($format=null)

	__asCsv ($separator=';', $header=false)

	__asArray ()

	__asStdClass ()

	__asSerializedObject ()

	buildFromArray (array $array)

	fixDateField ($field_name, $value)

	sleep ($field_name)

	wakeUp ($field_name, $field_value)

	getArrayForDb ()

	getArrayForConnector ()

	installConnector ()

	store ()

	save ()

	create ()

	copy ($new_id=0)

	afterObjectLoad ()

	read ()

	update ()

	delete ()

	__call ($name, $arguments)

Static Public Member Functions
static	register (isItem $item)

Static Public Member Functions inherited from CachedActiveRecord
static	find ($primary_key, array $add_constructor_args=array())
	@inheritDoc More...

static	connector (arConnector $connector)
	@inheritDoc More...

Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()

static	installDB ()

static	renameDBField ($old_name, $new_name)

static	tableExists ()

static	fieldExists ($field_name)

static	removeDBField ($field_name)

static	updateDB ()

static	resetDB ()

static	truncateDB ()

static	flushDB ()

static	preloadObjects ()

static	additionalParams (array $additional_params)

static	findOrFail ($primary_key, array $add_constructor_args=array())
	Tries to find the object and throws an Exception if object is not found, instead of returning null. More...

static	findOrGetInstance ($primary_key, array $add_constructor_args=array())

static	where ($where, $operator=null)

static	innerjoinAR (ActiveRecord $ar, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)

static	innerjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)

static	leftjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)

static	orderBy ($orderBy, $orderDirection='ASC')

static	dateFormat ($date_format='d.m.Y - H:i:s')

static	limit ($start, $end)

static	affectedRows ()

static	count ()

static	get ()

static	debug ()

static	first ()

static	getCollection ()

static	last ()

static	getFirstFromLastQuery ()

static	connector (arConnector $connector)

static	raw ($set_raw=true)

static	getArray ($key=null, $values=null)

static	_toCamelCase ($str, $capitalise_first_char=false)

Protected Attributes
	$identification

	$active = true

	$position = 0

	$parent_identification = ''

	$icon_id = ''

	$connector_container_name = "il_mm_items"

Protected Attributes inherited from ActiveRecord
	$ar_safe_read = true

	$connector_container_name = ''

Additional Inherited Members
Data Fields inherited from ActiveRecord
const	ACTIVE_RECORD_VERSION = '2.0.7'

Protected Member Functions inherited from ActiveRecord
	serializeToCSV ($field)
	This method is called for every field of your instance if you use __asCsv. More...

	installDatabase ()

Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()

static	fromCamelCase ($str)

Detailed Description

Class ilMMItemStorage.

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

Definition at line 11 of file class.ilMMItemStorage.php.

Member Function Documentation

◆ create()

ilMMItemStorage::create ( )

Reimplemented from CachedActiveRecord.

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

    {
        if (self::find($this->getIdentification())) {
            $this->update();
        } else {
            parent::create();
        }
    }

References getIdentification(), and CachedActiveRecord\update().

Here is the call graph for this function:

◆ getCache()

ilMMItemStorage::getCache ( )

@inheritDoc

Reimplemented from CachedActiveRecord.

Definition at line 56 of file class.ilMMItemStorage.php.

                               : ilGlobalCache
    {
        return ilGlobalCache::getInstance(ilGlobalCache::COMP_GLOBAL_SCREEN);
    }

References ilGlobalCache\COMP_GLOBAL_SCREEN, and ilGlobalCache\getInstance().

Here is the call graph for this function:

◆ getIconId()

ilMMItemStorage::getIconId ( )

Returns: string

Definition at line 185 of file class.ilMMItemStorage.php.

                                : ?string
    {
        return $this->icon_id;
    }

References $icon_id.

◆ getIdentification()

ilMMItemStorage::getIdentification ( )

Returns: string

Definition at line 113 of file class.ilMMItemStorage.php.

                                        : string
    {
        return $this->identification;
    }

References $identification.

Referenced by create().

Here is the caller graph for this function:

◆ getParentIdentification()

ilMMItemStorage::getParentIdentification ( )

Returns: string

Definition at line 167 of file class.ilMMItemStorage.php.

                                              : string
    {
        return $this->parent_identification;
    }

References $parent_identification.

◆ getPosition()

ilMMItemStorage::getPosition ( )

Returns: int

Definition at line 149 of file class.ilMMItemStorage.php.

                                  : int
    {
        return $this->position;
    }

References $position.

◆ isActive()

ilMMItemStorage::isActive ( )

Returns: bool

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

                               : bool
    {
        return $this->active;
    }

References $active.

◆ register()

static ilMMItemStorage::register ( isItem $item )

static

Parameters

isItem $item

Returns: ilMMItemStorage

Definition at line 19 of file class.ilMMItemStorage.php.

                                                  : ilMMItemStorage
    {
        if ($item instanceof Lost) {
            return new self();
        }
 
        $mm_item = ilMMItemStorage::find($item->getProviderIdentification()->serialize());
        if ($mm_item === null) {
            $mm_item = new ilMMItemStorage();
            $mm_item->setPosition($item->getPosition());
            $mm_item->setIdentification($item->getProviderIdentification()->serialize());
            $mm_item->setActive(true);
            if ($item instanceof \ILIAS\GlobalScreen\Scope\MainMenu\Factory\isChild) {
                $mm_item->setParentIdentification($item->getParent()->serialize());
            }
            $mm_item->create();
        }
 
        return $mm_item;
    }

References CachedActiveRecord\find().

Referenced by ilMMItemRepository\__construct(), ilMMAbstractItemFacade\__construct(), ilMMAbstractItemFacade\create(), and ILIAS\MainMenu\Provider\CustomMainBarProvider\getSingleCustomItem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setActive()

ilMMItemStorage::setActive ( bool $active )

Parameters

bool $active

Definition at line 140 of file class.ilMMItemStorage.php.

    {
        $this->active = $active;
    }

References $active.

◆ setIconId()

ilMMItemStorage::setIconId ( string $icon_id )

Parameters

string $icon_id

Returns: ilMMItemStorage

Definition at line 196 of file class.ilMMItemStorage.php.

                                               : ilMMItemStorage
    {
        $this->icon_id = $icon_id;
 
        return $this;
    }

References $icon_id.

◆ setIdentification()

ilMMItemStorage::setIdentification ( string $identification )

Parameters

string $identification

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

    {
        $this->identification = $identification;
    }

References $identification.

◆ setParentIdentification()

ilMMItemStorage::setParentIdentification ( string $parent_identification )

Parameters

string $parent_identification

Definition at line 176 of file class.ilMMItemStorage.php.

    {
        $this->parent_identification = $parent_identification;
    }

References $parent_identification.

◆ setPosition()

ilMMItemStorage::setPosition ( int $position )

Parameters

int $position

Definition at line 158 of file class.ilMMItemStorage.php.

    {
        $this->position = $position;
    }

References $position.

Field Documentation

◆ $active

ilMMItemStorage::$active = true

protected

Definition at line 79 of file class.ilMMItemStorage.php.

Referenced by isActive(), and setActive().

◆ $connector_container_name

ilMMItemStorage::$connector_container_name = "il_mm_items"

protected

Definition at line 107 of file class.ilMMItemStorage.php.

◆ $icon_id

ilMMItemStorage::$icon_id = ''

protected

Definition at line 103 of file class.ilMMItemStorage.php.

Referenced by getIconId(), and setIconId().

◆ $identification

ilMMItemStorage::$identification

protected

Definition at line 71 of file class.ilMMItemStorage.php.

Referenced by getIdentification(), and setIdentification().

◆ $parent_identification

ilMMItemStorage::$parent_identification = ''

protected

Definition at line 95 of file class.ilMMItemStorage.php.

Referenced by getParentIdentification(), and setParentIdentification().

◆ $position

ilMMItemStorage::$position = 0

protected

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

Referenced by getPosition(), and setPosition().

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

Services/MainMenu/classes/Items/class.ilMMItemStorage.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create()

◆ getCache()

◆ getIconId()

◆ getIdentification()

◆ getParentIdentification()

◆ getPosition()

◆ isActive()

◆ register()

◆ setActive()

◆ setIconId()

◆ setIdentification()

◆ setParentIdentification()

◆ setPosition()

Field Documentation

◆ $active

◆ $connector_container_name

◆ $icon_id

◆ $identification

◆ $parent_identification

◆ $position