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

	create ()

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

	read ()

	update ()

	delete ()

Public Member Functions inherited from ActiveRecord
	getArConnector ()

	getArFieldList ()

	getConnectorContainerName ()
	@description Return the Name of your Connector Table More...

	setConnectorContainerName (string $connector_container_name)

	getPrimaryFieldValue ()

	setPrimaryFieldValue ($value)

	__construct ($primary_key=0)

	storeObjectToCache ()

	asStdClass ()

	buildFromArray (array $array)

	fixDateField ($field_name, $value)

	sleep ($field_name)

	wakeUp ($field_name, $field_value)

	getArrayForConnector ()

	installConnector ()

	store ()

	save ()

	create ()

	copy (int $new_id=0)

	afterObjectLoad ()

	read ()

	update ()

	delete ()

	__call ($name, $arguments)

Static Public Member Functions
static	register (isItem $item)

Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()

static	installDB ()

static	renameDBField (string $old_name, string $new_name)

static	tableExists ()

static	fieldExists (string $field_name)

static	removeDBField (string $field_name)

static	updateDB ()

static	resetDB ()

static	truncateDB ()

static	flushDB ()
	@depracated never use in ILIAS Core, Plugins only More...

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, array $fields=array(' *'), string $operator='=', $both_external=false)

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

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

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

static	dateFormat (string $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 (bool $set_raw=true)

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

static	_toCamelCase (string $str, bool $capitalise_first_char=false)

Protected Attributes
string	$identification
	@con_is_primary true @con_is_unique true @con_has_field true @con_fieldtype text @con_length 64 More...

bool	$active = true
	@con_has_field true @con_fieldtype integer @con_length 1 More...

int	$position = 0
	@con_has_field true @con_fieldtype integer @con_length 4 More...

string	$parent_identification = ''
	@con_has_field true @con_fieldtype text @con_length 256 More...

string	$icon_id = ''
	@con_has_field true @con_fieldtype text @con_length 256 More...

string	$connector_container_name = "il_mm_items"

Protected Attributes inherited from ActiveRecord
bool	$ar_safe_read = true

string	$connector_container_name = ''

bool	$is_new = true

Additional Inherited Members
Protected Member Functions inherited from ActiveRecord
	installDatabase ()

Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()
	@description Returns an instance of the instatiated calling active record (needs to be done in static methods) @TODO : This should be cached somehow More...

static	fromCamelCase (string $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 27 of file class.ilMMItemStorage.php.

Member Function Documentation

◆ create()

ilMMItemStorage::create ( )

Reimplemented from CachedActiveRecord.

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

                            : void
    {
        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 71 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 190 of file class.ilMMItemStorage.php.

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

References $icon_id.

◆ getIdentification()

ilMMItemStorage::getIdentification ( )

Returns: string

Definition at line 118 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 172 of file class.ilMMItemStorage.php.

                                             : string
    {
        return $this->parent_identification;
    }

References $parent_identification.

◆ getPosition()

ilMMItemStorage::getPosition ( )

Returns: int

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

                                 : int
    {
        return $this->position;
    }

References $position.

◆ isActive()

ilMMItemStorage::isActive ( )

Returns: bool

Definition at line 136 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 34 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 isChild) {
                $mm_item->setParentIdentification($item->getParent()->serialize());
            }
            $mm_item->create();
        }
 
        return $mm_item;
    }

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

Here is the caller graph for this function:

◆ setActive()

ilMMItemStorage::setActive ( bool $active )

Parameters

bool $active

Definition at line 145 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 201 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 127 of file class.ilMMItemStorage.php.

    {
        $this->identification = $identification;
    }

References $identification.

◆ setParentIdentification()

ilMMItemStorage::setParentIdentification ( string $parent_identification )

Parameters

string $parent_identification

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

    {
        $this->parent_identification = $parent_identification;
    }

References $parent_identification.

◆ setPosition()

ilMMItemStorage::setPosition ( int $position )

Parameters

int $position

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

    {
        $this->position = $position;
    }

References $position.

Field Documentation

◆ $active

bool ilMMItemStorage::$active = true

protected

@con_has_field true @con_fieldtype integer @con_length 1

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

Referenced by isActive(), and setActive().

◆ $connector_container_name

string ilMMItemStorage::$connector_container_name = "il_mm_items"

protected

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

◆ $icon_id

string ilMMItemStorage::$icon_id = ''

protected

@con_has_field true @con_fieldtype text @con_length 256

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

Referenced by getIconId(), and setIconId().

◆ $identification

string ilMMItemStorage::$identification

protected

@con_is_primary true @con_is_unique true @con_has_field true @con_fieldtype text @con_length 64

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

Referenced by getIdentification(), and setIdentification().

◆ $parent_identification

string ilMMItemStorage::$parent_identification = ''

protected

@con_has_field true @con_fieldtype text @con_length 256

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

Referenced by getParentIdentification(), and setParentIdentification().

◆ $position

int ilMMItemStorage::$position = 0

protected

@con_has_field true @con_fieldtype integer @con_length 4

Definition at line 96 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