CachedActiveRecord Class Reference

Class CachedActiveRecord. More...

Inheritance diagram for CachedActiveRecord:

Collaboration diagram for CachedActiveRecord:

Public Member Functions
	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	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)

Private Member Functions
	buildHash ()

Private Attributes
	$_hash = ''

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)
Protected Attributes inherited from ActiveRecord
	$ar_safe_read = true
	$connector_container_name = ''

Detailed Description

Class CachedActiveRecord.

Author

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

Definition at line 7 of file class.CachedActiveRecord.php.

Constructor & Destructor Documentation

__construct()

CachedActiveRecord::__construct	(		$primary_key = 0,
		arConnector	$connector = null
	)

@inheritDoc

Reimplemented from ActiveRecord.

Definition at line 39 of file class.CachedActiveRecord.php.

    {
        if (is_null($connector)) {
            $connector = new arConnectorDB();
        }
 
        $connector = new arConnectorCache($connector);
        arConnectorMap::register($this, $connector);
        parent::__construct($primary_key, $connector);
    }

References arConnectorMap\register().

Here is the call graph for this function:

Member Function Documentation

afterObjectLoad()

CachedActiveRecord::afterObjectLoad

(

)

Reimplemented from ActiveRecord.

Definition at line 50 of file class.CachedActiveRecord.php.

    {
        parent::afterObjectLoad();
        $this->_hash = $this->buildHash();
    }

References buildHash().

Here is the call graph for this function:

buildFromArray()

CachedActiveRecord::buildFromArray

(

array

$array

)

@inheritDoc

Reimplemented from ActiveRecord.

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

    {
        return parent::buildFromArray($array);
    }

buildHash()

CachedActiveRecord::buildHash ( )

private

Definition at line 56 of file class.CachedActiveRecord.php.

                                 : string
    {
        $hashing = [];
        foreach ($this->getArFieldList()->getFields() as $field) {
            $name           = $field->getName();
            $hashing[$name] = $this->{$name};
        }
        return md5(serialize($hashing));
    }

References $name, and ActiveRecord\getArFieldList().

Referenced by afterObjectLoad(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

connector()

static CachedActiveRecord::connector ( arConnector  $connector )

static

@inheritDoc

Reimplemented from ActiveRecord.

Definition at line 134 of file class.CachedActiveRecord.php.

    {
        return parent::connector($connector); // TODO: Change the autogenerated stub
    }

copy()

CachedActiveRecord::copy

(

$new_id = 0

)

@inheritDoc

Reimplemented from ActiveRecord.

Definition at line 98 of file class.CachedActiveRecord.php.

    {
        $this->getCache()->flush();
        return parent::copy($new_id);
    }

References getCache().

Here is the call graph for this function:

create()

CachedActiveRecord::create

(

)

Reimplemented from ActiveRecord.

Reimplemented in ilGSIdentificationStorage, and ilMMItemStorage.

Definition at line 89 of file class.CachedActiveRecord.php.

    {
        $this->getCache()->flush();
        parent::create();
    }

References getCache().

Here is the call graph for this function:

delete()

CachedActiveRecord::delete

(

)

Reimplemented from ActiveRecord.

Definition at line 117 of file class.CachedActiveRecord.php.

    {
        $this->getCache()->flush();
        parent::delete(); // TODO: Change the autogenerated stub
    }

References getCache().

Here is the call graph for this function:

find()

static CachedActiveRecord::find (   $primary_key, array  $add_constructor_args = array()  )

static

@inheritDoc

Reimplemented in ilMMTypeActionStorage.

Definition at line 126 of file class.CachedActiveRecord.php.

    {
        return parent::find($primary_key, $add_constructor_args);
    }

Referenced by ilMMAbstractItemFacade\delete(), ilMMItemTranslationGUI\deleteTranslations(), ilMMCustomItemFacade\getCustomStorage(), ilMMCustomProvider\getSingleCustomItem(), ilMMItemTranslationStorage\hasDefaultTranslation(), ilMMAbstractItemFacade\hasStorage(), ilMMItemStorage\register(), ilGSIdentificationStorage\registerIdentification(), ilGSProviderStorage\registerIdentifications(), and ilMMItemTranslationStorage\storeTranslation().

Here is the caller graph for this function:

getCache()

CachedActiveRecord::getCache ( )

abstract

Returns

ilGlobalCache

Reimplemented in ilGSIdentificationStorage, ilGSProviderStorage, ilMMCustomItemStorage, ilMMItemStorage, ilMMItemTranslationStorage, and ilMMTypeActionStorage.

Referenced by copy(), create(), delete(), and update().

Here is the caller graph for this function:

getCacheIdentifier()

CachedActiveRecord::getCacheIdentifier ( )

final

Returns

string

Definition at line 22 of file class.CachedActiveRecord.php.

                                               : string
    {
        if ($this->getArFieldList()->getPrimaryField()) {
            return ($this->getConnectorContainerName() . "_" . $this->getPrimaryFieldValue());
        }
 
        return "";
    }

References ActiveRecord\getArFieldList(), ActiveRecord\getConnectorContainerName(), and ActiveRecord\getPrimaryFieldValue().

Referenced by arObjectCache\flush(), arObjectCache\get(), and arObjectCache\isCached().

Here is the call graph for this function:

Here is the caller graph for this function:

getTTL()

CachedActiveRecord::getTTL

(

)

Definition at line 31 of file class.CachedActiveRecord.php.

                             : int
    {
        return 60;
    }

read()

CachedActiveRecord::read

(

)

Exceptions

arException

Reimplemented from ActiveRecord.

Definition at line 104 of file class.CachedActiveRecord.php.

    {
        parent::read();
    }

save()

CachedActiveRecord::save

(

)

Reimplemented from ActiveRecord.

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

    {
        parent::save();
    }

store()

CachedActiveRecord::store

(

)

Reimplemented from ActiveRecord.

Definition at line 79 of file class.CachedActiveRecord.php.

    {
        parent::store();
    }

storeObjectToCache()

CachedActiveRecord::storeObjectToCache

(

)

Reimplemented from ActiveRecord.

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

    {
        parent::storeObjectToCache();
    }

update()

CachedActiveRecord::update

(

)

Reimplemented from ActiveRecord.

Definition at line 109 of file class.CachedActiveRecord.php.

    {
        if ($this->buildHash() !== $this->_hash) {
            $this->getCache()->flush();
            parent::update();
        }
    }

References buildHash(), getCache(), and League\Flysystem\Adapter\Polyfill\update().

Referenced by ilMMItemStorage\create().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$_hash

CachedActiveRecord::$_hash = ''

private

Definition at line 12 of file class.CachedActiveRecord.php.

---

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

• Services/ActiveRecord/class.CachedActiveRecord.php