Class cApiUserCollection

User collection

cGenericDb

cApiUserCollection

Package: Core\GenericDB\Model
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Bjoern Behrens
Author: Holger Librenz
Located at classes/contenido/class.user.php

Methods summary
`public`	# `__construct( string\|boolean $where = false )` Constructor to create an instance of this class. Constructor to create an instance of this class. Parameters `$where` `string\|boolean` $where [optional] The where clause in the select, usable to run select by creating the instance Throws `cDbException` `cInvalidArgumentException` Overrides `ItemCollection::__construct()`
`public cApiUser\|boolean`	# `create( string $username )` Createa a user by user name. Createa a user by user name. Parameters `$username` `string` $username Returns `cApiUser\|boolean` Throws `cDbException` `cException` `cInvalidArgumentException`
`public boolean`	# `deleteUserByUsername( string $username )` Removes the specified user from the database by users name. Removes the specified user from the database by users name. Parameters `$username` `string` $username Specifies the username Returns `boolean` True if the delete was successful Throws `cDbException` `cInvalidArgumentException`
`public array`	# `fetchAccessibleUsers( array $perms, boolean $includeAdmins = false, string $orderBy = '' )` Returns all users which are accessible by the current user. Returns all users which are accessible by the current user. Parameters `$perms` `array` $perms Permissions array `$includeAdmins` `boolean` $includeAdmins [optional] Flag to get admins (admin and sysadmin) too `$orderBy` `string` $orderBy [optional] Order by rule, uses 'realname, username' by default Returns `array` Array of user objects Throws `cDbException` `cException`
`public array`	# `getAccessibleUsers( array $perms, boolean $includeAdmins = false, string $orderBy = '' )` Returns all users which are accessible by the current user. Is a wrapper of fetchAccessibleUsers() and returns contrary to that function a multidimensional array instead of a list of objects. Returns all users which are accessible by the current user. Is a wrapper of fetchAccessibleUsers() and returns contrary to that function a multidimensional array instead of a list of objects. Parameters `$perms` `array` $perms Permissions array `$includeAdmins` `boolean` $includeAdmins [optional] Flag to get admins (admin and sysadmin) too `$orderBy` `string` $orderBy [optional] Order by rule, uses 'realname, username' by default Returns `array` Array of user like $arr[user_id][username], $arr[user_id][realname] Throws `cDbException` `cException`
`public array`	# `fetchAvailableUsers( string $orderBy = 'realname ASC' )` Returns all users available in the system Returns all users available in the system Parameters `$orderBy` `string` $orderBy [optional] SQL order by part Returns `array` Throws `cDbException` `cException`
`public array`	# `fetchSystemAdmins( boolean $forceActive = false )` Returns all system admins available in the system Returns all system admins available in the system Parameters `$forceActive` `boolean` $forceActive [optional] flag if only active sysadmins should be returned Returns `array` Array of user objects Throws `cDbException` `cException`
`public array`	# `fetchClientAdmins( integer $client )` Returns all system admins available in the system Returns all system admins available in the system Parameters `$client` `integer` $client Returns `array` Array of user objects Throws `cDbException` `cException`

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 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 cApiUserCollection

Parameters

Throws

Overrides

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws