This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilMMCustomItemStorage:

Collaboration diagram for ilMMCustomItemStorage:

Public Member Functions
	getIdentifier ()

	setIdentifier (string $identifier)

	getType ()

	setType (string $type)

	isTopItem ()

	setTopItem (bool $top_item)

	getAction ()

	setAction (string $action)

	hasRoleBasedVisibility ()

	setRoleBasedVisibility (bool $role_based_visibility)

	getGlobalRoleIDs ()

	setGlobalRoleIDs (array $global_role_ids)

	getDefaultTitle ()

	setDefaultTitle (string $default_title)

	getCache ()
	@inheritDoc More...

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)

Protected Attributes
	$identifier = ''

	$type = ''

	$action = ""

	$role_based_visibility = false

	$global_role_ids = ""

	$default_title = ""

	$top_item = false

	$connector_container_name = "il_mm_custom_items"

Protected Attributes inherited from ActiveRecord
	$ar_safe_read = true

	$connector_container_name = ''

Additional Inherited Members
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)

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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilMMCustomItemStorage

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

Definition at line 24 of file class.ilMMCustomItemStorage.php.

Member Function Documentation

◆ getAction()

ilMMCustomItemStorage::getAction ( )

Returns: string

Definition at line 160 of file class.ilMMCustomItemStorage.php.

                                : string
    {
        return $this->action;
    }

References $action.

◆ getCache()

ilMMCustomItemStorage::getCache ( )

@inheritDoc

Reimplemented from CachedActiveRecord.

Definition at line 252 of file class.ilMMCustomItemStorage.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:

◆ getDefaultTitle()

ilMMCustomItemStorage::getDefaultTitle ( )

Returns: string

Definition at line 230 of file class.ilMMCustomItemStorage.php.

                                      : string
    {
        return $this->default_title;
    }

References $default_title.

Referenced by ILIAS\MainMenu\Provider\CustomMainBarProvider\getSingleCustomItem().

Here is the caller graph for this function:

◆ getGlobalRoleIDs()

ilMMCustomItemStorage::getGlobalRoleIDs ( )

Returns: array

Definition at line 208 of file class.ilMMCustomItemStorage.php.

                                       : array
    {
        return array_map("intval", explode(",", $this->global_role_ids));
    }

Referenced by ilObjMainMenuAccess\isCurrentUserAllowedToSeeCustomItem().

Here is the caller graph for this function:

◆ getIdentifier()

ilMMCustomItemStorage::getIdentifier ( )

Returns: string

Definition at line 94 of file class.ilMMCustomItemStorage.php.

                                    : string
    {
        return $this->identifier;
    }

References $identifier.

Referenced by ILIAS\MainMenu\Provider\CustomMainBarProvider\getSingleCustomItem().

Here is the caller graph for this function:

◆ getType()

ilMMCustomItemStorage::getType ( )

Returns: string

Definition at line 116 of file class.ilMMCustomItemStorage.php.

                              : string
    {
        return $this->type;
    }

References $type.

Referenced by ILIAS\MainMenu\Provider\CustomMainBarProvider\getSingleCustomItem().

Here is the caller graph for this function:

◆ hasRoleBasedVisibility()

ilMMCustomItemStorage::hasRoleBasedVisibility ( )

Returns: bool

Definition at line 182 of file class.ilMMCustomItemStorage.php.

                                             : bool
    {
        if ($this->role_based_visibility !== null) {
            return $this->role_based_visibility;
        } else {
            return false;
        }
    }

References $role_based_visibility.

Referenced by ilObjMainMenuAccess\isCurrentUserAllowedToSeeCustomItem().

Here is the caller graph for this function:

◆ isTopItem()

ilMMCustomItemStorage::isTopItem ( )

Returns: bool

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

                                : bool
    {
        return $this->top_item;
    }

References $top_item.

◆ setAction()

ilMMCustomItemStorage::setAction ( string $action )

Parameters

string $action

Returns: ilMMCustomItemStorage

Definition at line 171 of file class.ilMMCustomItemStorage.php.

                                              : ilMMCustomItemStorage
    {
        $this->action = $action;
 
        return $this;
    }

References $action.

◆ setDefaultTitle()

ilMMCustomItemStorage::setDefaultTitle ( string $default_title )

Parameters

string $default_title

Returns: ilMMCustomItemStorage

Definition at line 241 of file class.ilMMCustomItemStorage.php.

                                                           : ilMMCustomItemStorage
    {
        $this->default_title = $default_title;
 
        return $this;
    }

References $default_title.

◆ setGlobalRoleIDs()

ilMMCustomItemStorage::setGlobalRoleIDs ( array $global_role_ids )

Parameters

array $global_role_ids

Returns: ilMMCustomItemStorage

Definition at line 219 of file class.ilMMCustomItemStorage.php.

                                                             : ilMMCustomItemStorage
    {
        $this->global_role_ids = implode(",", $global_role_ids);
 
        return $this;
    }

References $global_role_ids.

◆ setIdentifier()

ilMMCustomItemStorage::setIdentifier ( string $identifier )

Parameters

string $identifier

Returns: ilMMCustomItemStorage

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

                                                      : ilMMCustomItemStorage
    {
        $this->identifier = $identifier;
 
        return $this;
    }

References $identifier.

◆ setRoleBasedVisibility()

ilMMCustomItemStorage::setRoleBasedVisibility ( bool $role_based_visibility )

Parameters

bool $role_based_visibility

Returns: ilMMCustomItemStorage

Definition at line 197 of file class.ilMMCustomItemStorage.php.

                                                                        : ilMMCustomItemStorage
    {
        $this->role_based_visibility = $role_based_visibility;
 
        return $this;
    }

References $role_based_visibility.

◆ setTopItem()

ilMMCustomItemStorage::setTopItem ( bool $top_item )

Parameters

bool $top_item

Returns: ilMMCustomItemStorage

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

                                               : ilMMCustomItemStorage
    {
        $this->top_item = $top_item;
 
        return $this;
    }

References $top_item.

◆ setType()

ilMMCustomItemStorage::setType ( string $type )

Parameters

string $type

Returns: ilMMCustomItemStorage

Definition at line 127 of file class.ilMMCustomItemStorage.php.

                                          : ilMMCustomItemStorage
    {
        $this->type = $type;
 
        return $this;
    }

References $type.

Field Documentation

◆ $action

ilMMCustomItemStorage::$action = ""

protected

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

Referenced by getAction(), and setAction().

◆ $connector_container_name

ilMMCustomItemStorage::$connector_container_name = "il_mm_custom_items"

protected

Definition at line 88 of file class.ilMMCustomItemStorage.php.

◆ $default_title

ilMMCustomItemStorage::$default_title = ""

protected

Definition at line 76 of file class.ilMMCustomItemStorage.php.

Referenced by getDefaultTitle(), and setDefaultTitle().

◆ $global_role_ids

ilMMCustomItemStorage::$global_role_ids = ""

protected

Definition at line 68 of file class.ilMMCustomItemStorage.php.

Referenced by setGlobalRoleIDs().

◆ $identifier

ilMMCustomItemStorage::$identifier = ''

protected

Definition at line 36 of file class.ilMMCustomItemStorage.php.

Referenced by getIdentifier(), and setIdentifier().

◆ $role_based_visibility

ilMMCustomItemStorage::$role_based_visibility = false

protected

Definition at line 60 of file class.ilMMCustomItemStorage.php.

Referenced by hasRoleBasedVisibility(), and setRoleBasedVisibility().

◆ $top_item

ilMMCustomItemStorage::$top_item = false

protected

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

Referenced by isTopItem(), and setTopItem().

◆ $type

ilMMCustomItemStorage::$type = ''

protected

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

Referenced by getType(), and setType().

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getAction()

◆ getCache()

◆ getDefaultTitle()

◆ getGlobalRoleIDs()

◆ getIdentifier()

◆ getType()

◆ hasRoleBasedVisibility()

◆ isTopItem()

◆ setAction()

◆ setDefaultTitle()

◆ setGlobalRoleIDs()

◆ setIdentifier()

◆ setRoleBasedVisibility()

◆ setTopItem()

◆ setType()

Field Documentation

◆ $action

◆ $connector_container_name

◆ $default_title

◆ $global_role_ids

◆ $identifier

◆ $role_based_visibility

◆ $top_item

◆ $type