Inheritance diagram for ilGSProviderStorage:

Collaboration diagram for ilGSProviderStorage:

Public Member Functions
	getCache ()
	@inheritDoc More...

	getConnectorContainerName ()
	@inheritDoc More...

	getProviderClass ()

	setProviderClass (string $provider_class)

	getPurpose ()

	setPurpose (string $purpose)

	isDynamic ()

	setDynamic (bool $dynamic)

	getInstance ()

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	registerIdentifications (string $class_name, string $purpose)

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
	$provider_class

	$purpose = ''

	$dynamic = false

	$instance

	$connector_container_name = "il_gs_providers"

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 ilGSProviderStorage.

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

Definition at line 8 of file class.ilGSProviderStorage.php.

Member Function Documentation

◆ getCache()

ilGSProviderStorage::getCache ( )

@inheritDoc

Reimplemented from CachedActiveRecord.

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

◆ getConnectorContainerName()

ilGSProviderStorage::getConnectorContainerName ( )

final

@inheritDoc

Reimplemented from ActiveRecord.

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

    {
        return $this->connector_container_name;
    }

References $connector_container_name.

◆ getInstance()

ilGSProviderStorage::getInstance ( )

Returns: Provider

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

                                  : ILIAS\GlobalScreen\Provider\Provider
    {
        global $DIC;
        if (!$this->instance instanceof ILIAS\GlobalScreen\Provider\Provider) {
            $class_name = $this->provider_class;
            $this->instance = new $class_name($DIC);
        }
 
        return $this->instance;
    }

References $DIC, $instance, $provider_class, and Sabre\Event\Loop\instance().

Here is the call graph for this function:

◆ getProviderClass()

ilGSProviderStorage::getProviderClass ( )

Returns: string

Definition at line 97 of file class.ilGSProviderStorage.php.

                                       : string
    {
        return $this->provider_class;
    }

References $provider_class.

◆ getPurpose()

ilGSProviderStorage::getPurpose ( )

Returns: string

Definition at line 119 of file class.ilGSProviderStorage.php.

                                 : string
    {
        return $this->purpose;
    }

References $purpose.

◆ isDynamic()

ilGSProviderStorage::isDynamic ( )

Returns: bool

Definition at line 141 of file class.ilGSProviderStorage.php.

                                : bool
    {
        return $this->dynamic;
    }

References $dynamic.

◆ registerIdentifications()

static ilGSProviderStorage::registerIdentifications	(	string	$class_name,
		string	$purpose
	)

static

Parameters

string	$class_name
string	$purpose

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

    {
        if (!class_exists($class_name)) {
            throw new LogicException("Cannot store unknown provider {$class_name}");
        }
 
        $gsp = ilGSProviderStorage::find($class_name);
        if ($gsp === null) {
            $gsp = new ilGSProviderStorage();
            $gsp->setProviderClass($class_name);
            $gsp->create();
        }
        $gsp->setProviderClass($class_name);
        $gsp->setPurpose($purpose);
        $gsp->setDynamic(in_array(DynamicProvider::class, class_implements($class_name)));
        $gsp->update();
 
        $instance = $gsp->getInstance();
 
        foreach ($instance->getAllIdentifications() as $identification) {
            ilGSIdentificationStorage::registerIdentification($identification, $instance);
        }
    }

References $instance, $purpose, CachedActiveRecord\find(), and ilGSIdentificationStorage\registerIdentification().

Referenced by ilObjDefReader\handlerBeginTag(), and ilMMTopItemGUI\restore().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDynamic()

ilGSProviderStorage::setDynamic ( bool $dynamic )

Parameters

bool $dynamic

Returns: ilGSProviderStorage

Definition at line 152 of file class.ilGSProviderStorage.php.

                                              : ilGSProviderStorage
    {
        $this->dynamic = $dynamic;
 
        return $this;
    }

References $dynamic.

◆ setProviderClass()

ilGSProviderStorage::setProviderClass ( string $provider_class )

Parameters

string $provider_class

Returns: ilGSProviderStorage

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

                                                             : ilGSProviderStorage
    {
        $this->provider_class = $provider_class;
 
        return $this;
    }

References $provider_class.

◆ setPurpose()

ilGSProviderStorage::setPurpose ( string $purpose )

Parameters

string $purpose

Returns: ilGSProviderStorage

Definition at line 130 of file class.ilGSProviderStorage.php.

                                                : ilGSProviderStorage
    {
        $this->purpose = $purpose;
 
        return $this;
    }

References $purpose.

Field Documentation

◆ $connector_container_name

ilGSProviderStorage::$connector_container_name = "il_gs_providers"

protected

Definition at line 82 of file class.ilGSProviderStorage.php.

Referenced by getConnectorContainerName().

◆ $dynamic

ilGSProviderStorage::$dynamic = false

protected

Definition at line 74 of file class.ilGSProviderStorage.php.

Referenced by isDynamic(), and setDynamic().

◆ $instance

ilGSProviderStorage::$instance

protected

Definition at line 78 of file class.ilGSProviderStorage.php.

Referenced by getInstance(), and registerIdentifications().

◆ $provider_class

ilGSProviderStorage::$provider_class

protected

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

Referenced by getInstance(), getProviderClass(), and setProviderClass().

◆ $purpose

ilGSProviderStorage::$purpose = ''

protected

Definition at line 66 of file class.ilGSProviderStorage.php.

Referenced by getPurpose(), registerIdentifications(), and setPurpose().

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

Services/GlobalScreen/classes/class.ilGSProviderStorage.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getCache()

◆ getConnectorContainerName()

◆ getInstance()

◆ getProviderClass()

◆ getPurpose()

◆ isDynamic()

◆ registerIdentifications()

◆ setDynamic()

◆ setProviderClass()

◆ setPurpose()

Field Documentation

◆ $connector_container_name

◆ $dynamic

◆ $instance

◆ $provider_class

◆ $purpose