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

	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)

Protected Attributes
string	$identifier = ''
	@con_is_primary true @con_is_unique true @con_has_field true @con_fieldtype text @con_length 256 More...

string	$type = ''
	@con_has_field true @con_fieldtype text @con_length 128 More...

string	$action = ""
	@con_has_field true @con_fieldtype text @con_length 4000 More...

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

string	$global_role_ids = null
	@con_has_field true @con_fieldtype text @con_length 4000 More...

string	$default_title = ""
	@con_has_field true @con_fieldtype text @con_length 4000 More...

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

string	$connector_container_name = "il_mm_custom_items"

Protected Attributes inherited from ActiveRecord
bool	$ar_safe_read = true

string	$connector_container_name = ''

bool	$is_new = true

Additional Inherited Members
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 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 ilMMCustomItemStorage.

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

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

Member Function Documentation

◆ getAction()

ilMMCustomItemStorage::getAction ( )

Returns: string

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

                               : string
    {
        return $this->action;
    }

References $action.

◆ getCache()

ilMMCustomItemStorage::getCache ( )

@inheritDoc

Reimplemented from CachedActiveRecord.

Definition at line 235 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 213 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 191 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 81 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 103 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 169 of file class.ilMMCustomItemStorage.php.

                                            : bool
    {
        return $this->role_based_visibility;
    }

References $role_based_visibility.

Referenced by ilObjMainMenuAccess\isCurrentUserAllowedToSeeCustomItem().

Here is the caller graph for this function:

◆ isTopItem()

ilMMCustomItemStorage::isTopItem ( )

Returns: bool

Definition at line 125 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 158 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 224 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 202 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 92 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 180 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 136 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 114 of file class.ilMMCustomItemStorage.php.

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

References $type.

Field Documentation

◆ $action

string ilMMCustomItemStorage::$action = ""

protected

@con_has_field true @con_fieldtype text @con_length 4000

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

Referenced by getAction(), and setAction().

◆ $connector_container_name

string ilMMCustomItemStorage::$connector_container_name = "il_mm_custom_items"

protected

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

◆ $default_title

string ilMMCustomItemStorage::$default_title = ""

protected

@con_has_field true @con_fieldtype text @con_length 4000

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

Referenced by getDefaultTitle(), and setDefaultTitle().

◆ $global_role_ids

string ilMMCustomItemStorage::$global_role_ids = null

protected

@con_has_field true @con_fieldtype text @con_length 4000

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

Referenced by setGlobalRoleIDs().

◆ $identifier

string ilMMCustomItemStorage::$identifier = ''

protected

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

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

Referenced by getIdentifier(), and setIdentifier().

◆ $role_based_visibility

bool ilMMCustomItemStorage::$role_based_visibility = false

protected

@con_has_field true @con_fieldtype integer @con_length 1

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

Referenced by hasRoleBasedVisibility(), and setRoleBasedVisibility().

◆ $top_item

bool ilMMCustomItemStorage::$top_item = false

protected

@con_has_field true @con_fieldtype integer @con_length 1

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

Referenced by isTopItem(), and setTopItem().

◆ $type

string ilMMCustomItemStorage::$type = ''

protected

@con_has_field true @con_fieldtype text @con_length 128

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