ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilGSIdentificationStorage Class Reference

Class ilGSProviderStorage. More...

+ Inheritance diagram for ilGSIdentificationStorage:
+ Collaboration diagram for ilGSIdentificationStorage:

Public Member Functions

 getCache ()
 
 create ()
 
 getIdentification ()
 
 setIdentification (string $identification)
 
 getProviderClass ()
 
 setProviderClass (string $provider_class)
 
 isActive ()
 
 setActive (bool $active)
 
- Public Member Functions inherited from CachedActiveRecord
 getCache ()
 
 getCacheIdentifier ()
 
 getTTL ()
 
 __construct ($primary_key=0, arConnector $connector=null)
 
 afterObjectLoad ()
 
 storeObjectToCache ()
 
 buildFromArray (array $array)
 
 store ()
 
 save ()
 
 create ()
 
 copy ($new_id=0)
 
 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 registerIdentification (\ILIAS\GlobalScreen\Identification\IdentificationInterface $identification, \ILIAS\GlobalScreen\Provider\Provider $provider)
 
- Static Public Member Functions inherited from CachedActiveRecord
static find ($primary_key, array $add_constructor_args=array())
 
static connector (arConnector $connector)
 
- 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
 
 $provider_class = ''
 
 $active = true
 
 $connector_container_name = "il_gs_identifications"
 
- 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

Member Function Documentation

◆ create()

ilGSIdentificationStorage::create ( )
final

Definition at line 69 of file class.ilGSIdentificationStorage.php.

70  {
71  if (empty($this->identification)) {
72  throw new LogicException("Cannot store without identification");
73  }
74  parent::create();
75  }

◆ getCache()

ilGSIdentificationStorage::getCache ( )

Definition at line 63 of file class.ilGSIdentificationStorage.php.

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

+ Here is the call graph for this function:

◆ getIdentification()

ilGSIdentificationStorage::getIdentification ( )
Returns
string

Definition at line 81 of file class.ilGSIdentificationStorage.php.

References $identification.

81  : string
82  {
83  return $this->identification;
84  }

◆ getProviderClass()

ilGSIdentificationStorage::getProviderClass ( )
Returns
string

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

References $provider_class.

103  : string
104  {
105  return $this->provider_class;
106  }

◆ isActive()

ilGSIdentificationStorage::isActive ( )
Returns
bool

Definition at line 125 of file class.ilGSIdentificationStorage.php.

References $active.

125  : bool
126  {
127  return $this->active;
128  }

◆ registerIdentification()

static ilGSIdentificationStorage::registerIdentification ( \ILIAS\GlobalScreen\Identification\IdentificationInterface  $identification,
\ILIAS\GlobalScreen\Provider\Provider  $provider 
)
static
Parameters
\ILIAS\GlobalScreen\Identification\IdentificationInterface$identification
\ILIAS\GlobalScreen\Provider\Provider$provider

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

References CachedActiveRecord\find().

Referenced by ilMMCustomProvider\getSingleCustomItem(), ilGSProviderStorage\registerIdentifications(), and ilMMItemRepository\sync().

48  {
50  if ($gsi === null) {
51  $gsi = new ilGSIdentificationStorage();
52  $gsi->setIdentification($identification->serialize());
53  $gsi->setProviderClass(get_class($provider));
54  $gsi->create();
55  }
56  $gsi->update();
57  }
static find($primary_key, array $add_constructor_args=array())
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setActive()

ilGSIdentificationStorage::setActive ( bool  $active)
Parameters
bool$active
Returns
ilGSIdentificationStorage

Definition at line 136 of file class.ilGSIdentificationStorage.php.

References $active.

137  {
138  $this->active = $active;
139 
140  return $this;
141  }

◆ setIdentification()

ilGSIdentificationStorage::setIdentification ( string  $identification)
Parameters
string$identification
Returns
ilGSIdentificationStorage

Definition at line 92 of file class.ilGSIdentificationStorage.php.

References $identification.

93  {
94  $this->identification = $identification;
95 
96  return $this;
97  }

◆ setProviderClass()

ilGSIdentificationStorage::setProviderClass ( string  $provider_class)
Parameters
string$provider_class
Returns
ilGSIdentificationStorage

Definition at line 114 of file class.ilGSIdentificationStorage.php.

References $provider_class.

115  {
116  $this->provider_class = $provider_class;
117 
118  return $this;
119  }

Field Documentation

◆ $active

ilGSIdentificationStorage::$active = true
protected

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

Referenced by isActive(), and setActive().

◆ $connector_container_name

ilGSIdentificationStorage::$connector_container_name = "il_gs_identifications"
protected

Definition at line 40 of file class.ilGSIdentificationStorage.php.

◆ $identification

ilGSIdentificationStorage::$identification
protected

Definition at line 20 of file class.ilGSIdentificationStorage.php.

Referenced by getIdentification(), and setIdentification().

◆ $provider_class

ilGSIdentificationStorage::$provider_class = ''
protected

Definition at line 28 of file class.ilGSIdentificationStorage.php.

Referenced by getProviderClass(), and setProviderClass().


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