Class cApiUserPropertyCollection

User property collection

cGenericDb

cApiUserPropertyCollection

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

Methods summary
`public`	# `__construct( string $userId )` Constructor to create an instance of this class. Constructor to create an instance of this class. Parameters `$userId` `string` $userId Throws `cDbException` `cException` `cInvalidArgumentException` Overrides `ItemCollection::__construct()`
`public static`	# `reset( )` Resets the states of static properties. Resets the states of static properties.
`public`	# `setUserId( string $userId )` User id setter User id setter Parameters `$userId` `string` $userId Throws `cDbException` `cException` `cInvalidArgumentException` If passed user id is empty
`public cApiUserProperty`	# `setValueByTypeName( string $type, string $name, string $value, integer $idcatlang = 0 )` Updates an existing user property entry or creates it. Updates an existing user property entry or creates it. Parameters `$type` `string` $type `$name` `string` $name `$value` `string` $value `$idcatlang` `integer` $idcatlang [optional] Returns `cApiUserProperty` Throws `cDbException` `cException` `cInvalidArgumentException`
`public cApiUserProperty`	# `create( string $type, string $name, string $value, integer $idcatlang = 0 )` Creates a user property entry. Creates a user property entry. Parameters `$type` `string` $type `$name` `string` $name `$value` `string` $value `$idcatlang` `integer` $idcatlang [optional] Returns `cApiUserProperty` Throws `cDbException` `cException` `cInvalidArgumentException`
`public array`	# `fetchByUserId( )` Returns all user properties by userid. Returns all user properties by userid. Returns `array` Throws `cDbException` `cException`
`public array`	# `fetchByTypeName( string $type, string $name )` Returns all user properties of all users by type and name. NOTE: Enabled caching will be skipped in this case, since it will return settings for all usery! Returns all user properties of all users by type and name. NOTE: Enabled caching will be skipped in this case, since it will return settings for all usery! Parameters `$type` `string` $type `$name` `string` $name Returns `array` Throws `cDbException` `cException`
`public cApiUserProperty\|null`	# `fetchByUserIdTypeName( string $type, string $name )` Returns all user properties by userid, type and name. Returns all user properties by userid, type and name. Parameters `$type` `string` $type `$name` `string` $name Returns `cApiUserProperty\|null` Throws `cDbException` `cException`
`public array`	# `fetchByUserIdType( string $type )` Returns all user properties by userid and type. Returns all user properties by userid and type. Parameters `$type` `string` $type Returns `array` Throws `cDbException` `cException`
`public boolean`	# `deleteByUserIdTypeName( string $type, string $name )` Deletes user property by userid, type and name. Deletes user property by userid, type and name. Parameters `$type` `string` $type `$name` `string` $name Returns `boolean` Throws `cDbException` `cException` `cInvalidArgumentException`
`public boolean`	# `deleteByUserIdType( string $type )` Deletes user properties by userid and type. Deletes user properties by userid and type. Parameters `$type` `string` $type Returns `boolean` Throws `cDbException` `cException` `cInvalidArgumentException`
`public boolean`	# `deleteByUserId( )` Deletes all user properties by userid. Deletes all user properties by userid. Returns `boolean` Throws `cDbException` `cException` `cInvalidArgumentException`
`protected boolean`	# `_deleteSelected( )` Deletes selected user properties. Deletes selected user properties. Returns `boolean` Throws `cDbException` `cException` `cInvalidArgumentException`
`protected`	# `_loadFromCache( )` Loads/Caches all user properties. Loads/Caches all user properties. Throws `cDbException` `cException`
`protected`	# `_addToCache( cApiUserProperty $entry )` Adds a entry to the cache. Adds a entry to the cache. Parameters `$entry` `cApiUserProperty` $entry
`protected array`	# `_fetchByUserIdFromCache( )` Fetches all user properties by userid from cache. Fetches all user properties by userid from cache. Returns `array`
`public cApiUserProperty\|null`	# `_fetchByUserIdTypeNameFromCache( string $type, string $name )` Fetches user properties by userid, type and name from cache. Fetches user properties by userid, type and name from cache. Parameters `$type` `string` $type `$name` `string` $name Returns `cApiUserProperty\|null`
`public array`	# `_fetchByUserIdTypeFromCache( string $type )` Fetches user properties by userid and type from cache. Fetches user properties by userid and 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(), 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`	`$_userId`	`''`	# User id (usually the current logged in user) User id (usually the current logged in user)
`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 cApiUserPropertyCollection

Parameters

Throws

Overrides

Parameters

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Returns

Throws

Returns

Throws

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters