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)
	afterObjectLoad ()
	create ()
	copy (int $new_id=0)
	read ()
	update ()
	delete ()
Public Member Functions inherited from ActiveRecord
	getArConnector ()
	getArFieldList ()
	getConnectorContainerName ()
	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)

Private Member Functions
	buildHash ()

Private Attributes
string	$_hash = ''

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 ()
	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 ()
	Returns an instance of the instatiated calling active record (needs to be done in static methods) : This should be cached somehow More...
static	fromCamelCase (string $str)
Protected Attributes inherited from ActiveRecord
bool	$ar_safe_read = true
string	$connector_container_name = ''
bool	$is_new = true

Detailed Description

Class CachedActiveRecord.

Author

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

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

Constructor & Destructor Documentation

__construct()

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

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

References ILIAS\GlobalScreen\Provider\__construct(), and arConnectorMap\register().

    {
        if (is_null($connector)) {
            $connector = new arConnectorDB();
        }

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

Here is the call graph for this function:

Member Function Documentation

afterObjectLoad()

CachedActiveRecord::afterObjectLoad

(

)

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

References buildHash().

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

Here is the call graph for this function:

buildHash()

CachedActiveRecord::buildHash ( )

private

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

References $name, and ActiveRecord\getArFieldList().

Referenced by afterObjectLoad(), read(), and update().

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

Here is the call graph for this function:

Here is the caller graph for this function:

copy()

CachedActiveRecord::copy

(

int

$new_id = 0

)

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

References getCache().

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

Here is the call graph for this function:

create()

CachedActiveRecord::create

(

)

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

References getCache().

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

Here is the call graph for this function:

delete()

CachedActiveRecord::delete

(

)

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

References getCache().

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

Here is the call graph for this function:

getCache()

CachedActiveRecord::getCache ( )

abstract

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

Here is the caller graph for this function:

getCacheIdentifier()

CachedActiveRecord::getCacheIdentifier ( )

final

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

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

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

        return "";
    }

Here is the call graph for this function:

getTTL()

CachedActiveRecord::getTTL

(

)

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

                            : int
    {
        return 60;
    }

read()

CachedActiveRecord::read

(

)

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

References buildHash().

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

Here is the call graph for this function:

update()

CachedActiveRecord::update

(

)

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

References buildHash(), and getCache().

Referenced by ilMMItemStorage\create().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$_hash

string CachedActiveRecord::$_hash = ''

private

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

---

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

• Services/ActiveRecord/class.CachedActiveRecord.php