Class cApiGroupPropertyCollection

Group property collection.

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

cGenericDb

cItemBaseAbstract

ItemCollection

cApiGroupPropertyCollection

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.group.property.php

Methods summary
`public`	# `__construct( string $groupId )` Constructor to create an instance of this class. Constructor to create an instance of this class. Parameters `$groupId` `string` $groupId Throws `cInvalidArgumentException` If table name or primary key is not set Overrides `ItemCollection::__construct()`
`public static`	# `reset( )` Resets the states of static properties. Resets the states of static properties.
`public`	# `setGroupId( string $groupId )` Group id setter Group id setter Parameters `$groupId` `string` $groupId Throws `cInvalidArgumentException` If passed group id is empty
`public cApiGroupProperty`	# `setValueByTypeName( string $type, string $name, string $value, integer $idcatlang = 0 )` Updatess a existing group property entry or creates it. Updatess a existing group property entry or creates it. Parameters `$type` `string` $type `$name` `string` $name `$value` `string` $value `$idcatlang` `integer` $idcatlang [optional] Returns `cApiGroupProperty`
`public cApiGroupProperty`	# `create( string $type, string $name, string $value, integer $idcatlang = 0 )` Creates a group property entry. Creates a group property entry. Parameters `$type` `string` $type `$name` `string` $name `$value` `string` $value `$idcatlang` `integer` $idcatlang [optional] Returns `cApiGroupProperty`
`public cApiGroupProperty\|null`	# `fetchByGroupIdTypeName( string $type, string $name )` Returns group property by groupid, type and name. Returns group property by groupid, type and name. Parameters `$type` `string` $type `$name` `string` $name Returns `cApiGroupProperty\|null`
`public array`	# `fetchByGroupIdType( string $type )` Returns all group properties by groupid and type. Returns all group properties by groupid and type. Parameters `$type` `string` $type Returns `array`
`public array`	# `fetchByGroupId( )` Returns all group properties by groupid. Returns all group properties by groupid. Returns `array`
`public boolean`	# `deleteByGroupIdTypeName( string $type, string $name )` Deletes group property by groupid, type and name. Deletes group property by groupid, type and name. Parameters `$type` `string` $type `$name` `string` $name Returns `boolean`
`public boolean`	# `deleteByGroupIdType( string $type )` Deletes group properties by groupid and type. Deletes group properties by groupid and type. Parameters `$type` `string` $type Returns `boolean`
`public boolean`	# `deleteByGroupId( )` Deletes all group properties by groupid. Deletes all group properties by groupid. Returns `boolean`
`protected boolean`	# `_deleteSelected( )` Deletes selected group properties. Deletes selected group properties. Returns `boolean`
`protected`	# `_loadFromCache( )` Loads/Caches all group properties. Loads/Caches all group properties.
`protected`	# `_addToCache( cApiGroupProperty $item )` Adds a entry to the cache. Adds a entry to the cache. Parameters `$item` `cApiGroupProperty` $entry
`protected cApiGroupProperty`	# `_fetchByGroupIdTypeNameFromCache( string $type, string $name )` Fetches group property by groupid, type and name from cache. Fetches group property by groupid, type and name from cache. Parameters `$type` `string` $type `$name` `string` $name Returns `cApiGroupProperty` NULL
`protected array`	# `_fetchByGroupIdTypeFromCache( string $type )` Fetches all group properties by groupid and type from cache. Fetches all group properties by groupid and type from cache. Parameters `$type` `string` $type Returns `array`
`protected array`	# `_fetchByGroupIdFromCache( )` Fetches all group properties by groupid from cache. Fetches all group properties by groupid from cache. 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(), fetchById(), 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 string`	`$_groupId`	`''`	# Groups id (usually the current logged in users group) Groups id (usually the current logged in users group)
`protected static array`	`$_entries`		# List of cached entries List of cached entries
`protected static boolean`	`$_enableCache`		# Flag to enable caching. Flag to enable caching.
`protected static integer`	`$_maxGroups`	`3`	# Number of max groups to cache proerties from. Number of max groups to cache proerties from.

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 cApiGroupPropertyCollection

Parameters

Throws

Overrides

Parameters

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters