Class cApiSearchTrackingCollection

Tracking collection

cGenericDb

cApiSearchTrackingCollection

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

Methods summary
`public`	# `__construct( )` Constructor to create an instance of this class. Constructor to create an instance of this class. Throws `cInvalidArgumentException` Overrides `ItemCollection::__construct()`
`public boolean`	# `create( string $searchTerm, integer $searchResults, string $timestamp = "", integer $idclient = 0, integer $idlang = 0 )` Create a new tracking row Create a new tracking row Parameters `$searchTerm` `string` $searchTerm Term the user searched for `$searchResults` `integer` $searchResults Number of results `$timestamp` `string` $timestamp [optional] Timestamp of the search `$idclient` `integer` $idclient [optional] Client `$idlang` `integer` $idlang [optional] Language Returns `boolean` Throws `cDbException` `cException` `cInvalidArgumentException`
`public boolean`	# `trackSearch( string $searchTerm, integer $resultCount )` Track a search if the setting allows it. Track a search if the setting allows it. Parameters `$searchTerm` `string` $searchTerm Term the user searched for `$resultCount` `integer` $resultCount Number of results Returns `boolean` Throws `cDbException` `cException` `cInvalidArgumentException`
`public boolean`	# `selectPopularSearchTerms( integer $idclient = 0, integer $idlang = 0 )` Select all search terms of this client and language and sort them by popularity Select all search terms of this client and language and sort them by popularity Deprecated Since 4.10.1, We can't use fields created by AVG or COUNT here! Result sets received by this function will contain all search term entries, not the cumulated ones. Parameters `$idclient` `integer` $idclient [optional] Use this client instead of the current one `$idlang` `integer` $idlang [optional] Use this language instead of the current one Returns `boolean` Throws `cDbException`
`public cDb`	# `queryPopularSearchTerms( integer $idclient = 0, integer $idlang = 0 )` Query all search terms of this client and language, group them by search term and sort them by popularity. Query all search terms of this client and language, group them by search term and sort them by popularity. The record sets created by this query contain following fields: searchterm = The search term avgresults = Average result of the search term countsearchterm = The number of search for the search term Parameters `$idclient` `integer` $idclient [optional] Use this client instead of the current one `$idlang` `integer` $idlang [optional] Use this language instead of the current one Returns `cDb` Throws `cDbException`
`public boolean`	# `selectSearchTerm( string $term, integer $idclient = 0, integer $idlang = 0 )` Select all entries about one search term for this client and language sorted by the date Select all entries about one search term for this client and language sorted by the date Parameters `$term` `string` $term Term the user searched for `$idclient` `integer` $idclient [optional] Use this client instead of the current one `$idlang` `integer` $idlang [optional] Use this language instead of the current one Returns `boolean` Throws `cDbException`

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 cApiSearchTrackingCollection

Throws

Overrides

Parameters

Returns

Throws

Parameters

Returns

Throws

Deprecated

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws