Class cApiSystemPropertyCollection

System property collection

The cApiSystemPropertyCollection class keeps also track of changed and deleted properties and synchronizes them with cached values, as long as you use the interface of cApiSystemPropertyCollection to manage the properties.

cGenericDb

cItemBaseAbstract

ItemCollection

cApiSystemPropertyCollection

Package: Core\GenericDB\Model
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Murat Purc <murat@purc.de>
Located at classes/contenido/class.system.property.php

Methods summary
`public`	# `__construct( )` Constructor to create an instance of this class. Constructor to create an instance of this class. Throws `cDbException` `cException` `cInvalidArgumentException` Overrides `ItemCollection::__construct()`
`public static`	# `reset( )` Resets the states of static properties. Resets the states of static properties.
`public cApiSystemProperty\|null`	# `setTypeNameValueById( string $type, string $name, string $value, integer $id )` Updatess a existing system property entry by it's id. Updatess a existing system property entry by it's id. Parameters `$type` `string` $type `$name` `string` $name `$value` `string` $value `$id` `integer` $id Returns `cApiSystemProperty\|null` Throws `cDbException` `cException` `cInvalidArgumentException`
`public cApiSystemProperty`	# `setValueByTypeName( string $type, string $name, string $value )` Updatess a existing system property entry or creates it. Updatess a existing system property entry or creates it. Parameters `$type` `string` $type `$name` `string` $name `$value` `string` $value Returns `cApiSystemProperty` Throws `cDbException` `cException` `cInvalidArgumentException`
`public cApiSystemProperty`	# `create( string $type, string $name, string $value )` Creates a system property entry. Creates a system property entry. Parameters `$type` `string` $type `$name` `string` $name `$value` `string` $value Returns `cApiSystemProperty` Throws `cDbException` `cException` `cInvalidArgumentException`
`public array`	# `fetchAll( string $orderBy = '' )` Returns all system properties. Returns all system properties. Parameters `$orderBy` `string` $orderBy [optional] Order by clause like "value ASC" Returns `array` Throws `cDbException` `cException`
`public cApiSystemProperty`	# `fetchById( integer $id )` Returns system property by it's id. Returns system property by it's id. Parameters `$id` `integer` $id Returns `cApiSystemProperty` NULL Throws `cException` Overrides `ItemCollection::fetchById()`
`public cApiSystemProperty`	# `fetchByTypeName( string $type, string $name )` Returns all system properties by type and name. Returns all system properties by type and name. Parameters `$type` `string` $type `$name` `string` $name Returns `cApiSystemProperty` NULL Throws `cDbException` `cException`
`public array`	# `fetchByType( string $type )` Returns all system properties by type. Returns all system properties by type. Parameters `$type` `string` $type Returns `array` Throws `cDbException` `cException`
`public boolean`	# `deleteByTypeName( string $type, string $name )` Deletes system property by type and name. Deletes system property by type and name. Parameters `$type` `string` $type `$name` `string` $name Returns `boolean` Throws `cDbException` `cException` `cInvalidArgumentException`
`public boolean`	# `deleteByType( string $type )` Deletes system properties by type. Deletes system properties by type. Parameters `$type` `string` $type Returns `boolean` Throws `cDbException` `cException` `cInvalidArgumentException`
`protected boolean`	# `_deleteSelected( )` Deletes selected system properties. Deletes selected system properties. Returns `boolean` Throws `cDbException` `cException` `cInvalidArgumentException`
`protected`	# `_loadFromCache( )` Loads/Caches all system properties. Loads/Caches all system properties. Throws `cDbException` `cException`
`protected`	# `_addToCache( cApiSystemProperty $entry )` Adds a entry to the cache. Adds a entry to the cache. Parameters `$entry` `cApiSystemProperty` $entry
`protected array`	# `_fetchAllFromCache( )` Fetches all entries from cache. Fetches all entries from cache. Returns `array`
`protected cApiSystemProperty\|null`	# `_fetchByIdFromCache( integer $id )` Fetches entry by id from cache. Fetches entry by id from cache. Parameters `$id` `integer` $id Returns `cApiSystemProperty\|null`
`protected cApiSystemProperty\|null`	# `_fetchByTypeNameFromCache( string $type, string $name )` Fetches entry by type and name from cache. Fetches entry by type and name from cache. Parameters `$type` `string` $type `$name` `string` $name Returns `cApiSystemProperty\|null`
`protected array`	# `_fetchByTypeFromCache( string $type )` Fetches entries by type from cache. Fetches entries by type from cache. Parameters `$type` `string` $type Returns `array`
`protected`	# `_deleteFromCache( integer $id )` Removes a entry from cache. Removes a entry from cache. Parameters `$id` `integer` $id

Methods inherited from ItemCollection
_buildGroupWhereStatements(), _buildWhereStatements(), _delete(), _deleteMultiple(), _fetchJoinTables(), _findReverseJoinPartner(), _initializeDriver(), _recursiveStructuredFetch(), _resolveLinks(), _setItemClass(), _setJoinPartner(), addResultField(), copyItem(), count(), createNewItem(), delete(), deleteBy(), deleteByWhereClause(), deleteWhere(), deleteWhereGroup(), exists(), fetchArray(), fetchObject(), fetchTable(), flexSelect(), getAllIds(), getFieldsByWhereClause(), getIdsByWhereClause(), link(), loadItem(), next(), query(), queryAndFetchStructured(), removeResultField(), resetQuery(), select(), setEncoding(), setGroupCondition(), setInnerGroupCondition(), setLimit(), setOrder(), setWhere(), setWhereGroup()

Methods inherited from cItemBaseAbstract
`__get(), __set(), _getPropertiesCollectionInstance(), _getSecondDBInstance(), _resetItem(), _setLoaded(), _setPrimaryKeyName(), escape(), getPrimaryKeyName(), isLoaded()`

Methods inherited from cGenericDb
`_executeCallbacks(), register(), unregister()`

Constants inherited from cGenericDb
`CREATE_BEFORE, CREATE_FAILURE, CREATE_SUCCESS, DELETE_BEFORE, DELETE_FAILURE, DELETE_SUCCESS, STORE_BEFORE, STORE_FAILURE, STORE_SUCCESS`

Properties summary
`protected static array`	`$_entries`		# List of cached entries List of cached entries
`protected static boolean`	`$_enableCache`		# Flag to enable caching. Flag to enable caching.

Properties inherited from ItemCollection
`$_JoinPartners, $_aOperators, $_bAllMode, $_collectionCache, $_driver, $_encoding, $_forwardJoinPartners, $_groupConditions, $_innerGroupConditions, $_itemClass, $_itemClassInstance, $_iteratorItem, $_lastSQL, $_limitCount, $_limitStart, $_links, $_order, $_resultFields, $_where, $_whereRestriction, $objects`

Properties inherited from cItemBaseAbstract
`$_className, $_loaded, $_oCache, $_primaryKeyName, $_settings, $db, $lasterror, $properties, $secondDb, $table`

Packages

Classes

Class cApiSystemPropertyCollection

Throws

Overrides

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Returns

Throws

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters