Class cApiOnlineUserCollection

Online user collection

cGenericDb

cApiOnlineUserCollection

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

Methods summary
`public`	# `__construct( boolean $select = false )` Constructor to create an instance of this class. Constructor to create an instance of this class. Parameters `$select` `boolean` $select [optional] where clause to use for selection (see ItemCollection::select()) Throws `cDbException` `cInvalidArgumentException` Overrides `ItemCollection::__construct()`
`public`	# `startUsersTracking( string $userId = NULL )` Start the User Tracking: First delete all inactive users with timelimit is off If find user in the table, do update Else there is no current user do insert new user Start the User Tracking: First delete all inactive users with timelimit is off If find user in the table, do update Else there is no current user do insert new user Parameters `$userId` `string` $userId [optional] Id of user Throws `cDbException` `cException` `cInvalidArgumentException`
`public boolean`	# `insertOnlineUser( string $userId )` Insert this user in online_user table Insert this user in online_user table Parameters `$userId` `string` $userId Id of user Returns `boolean` Returns true if successful else false Throws `cDbException` `cException` `cInvalidArgumentException`
`public boolean`	# `findUser( string $userId )` Find the this user if exists in the table 'online_user' Find the this user if exists in the table 'online_user' Parameters `$userId` `string` $userId Is the User-Id (get from auth object) Returns `boolean` Returns true if this User is found, else false
`public array`	# `findAllUser( )` Find all user_ids in the table 'online_user' for get rest information from table 'con_user' Find all user_ids in the table 'online_user' for get rest information from table 'con_user' Returns `array` Returns array of user-information Throws `cDbException` `cException`
`public boolean`	# `updateUser( string $userId )` This function do an update of current timestamp in 'online_user' This function do an update of current timestamp in 'online_user' Parameters `$userId` `string` $userId Is the User-Id (get from auth object) Returns `boolean` Returns true if successful, else false Throws `cDbException` `cInvalidArgumentException`
`public boolean`	# `deleteInactiveUser( )` Delete all Contains in the table 'online_user' that is older as Backend timeout(currently is $cfg['backend']['timeout'] = 60) Delete all Contains in the table 'online_user' that is older as Backend timeout(currently is $cfg['backend']['timeout'] = 60) Returns `boolean` Returns true if successful else false Throws `cDbException` `cInvalidArgumentException`
`public integer`	# `getNumberOfUsers( )` Get the number of users from the table 'online_user' Get the number of users from the table 'online_user' Returns `integer` Returns if exists a number of users Throws `cDbException`
`public boolean`	# `deleteUser( string $userId )` Delete this user from 'online user' table Delete this user from 'online user' table Parameters `$userId` `string` $userId Is the User-Id (get from auth object) Returns `boolean` Returns true if successful, else false Throws `cDbException` `cInvalidArgumentException`

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 cApiOnlineUserCollection

Parameters

Throws

Overrides

Parameters

Throws

Parameters

Returns

Throws

Parameters

Returns

Returns

Throws

Parameters

Returns

Throws

Returns

Throws

Returns

Throws

Parameters

Returns

Throws