AfsOrigin Class Reference

Defines various query origins. More...

Inheritance diagram for AfsOrigin:

Public Attributes
const	DIRECT = 'DIRECT'
	Direct access.
Items in the page
const	SEARCHBOX = 'SEARCHBOX'
	Query originates from search box.
const	ACP = 'ACP'
	Query originates from suggestion.
const	FACET = 'FACET'
	Query originates from facet value.
const	PAGER = 'PAGER'
	Query originates from page change.
const	SORT_ORIG = 'SORT_ORIG'
const	PREFERENCES = 'PREFERENCES'
	Preferences such as number of replies per page.
const	RESULT = 'RESULT'
Agents
const	SPELLCHECK = 'SPELLCHECK'
	Query originates from spellcheck proposal.
const	RTE = 'RTE'
	Query originates from related searches.
const	CONCEPT = 'CONCEPT'
	Query originates from one of the interpretation of the query.
const	PROMOTE = 'PROMOTE'
	Query originates from advertisement.
const	ACC = 'ACC'
E-commerce specific
const	SHOPPING_CART = 'SHOPPING_CART'
const	PRODUCT_DESCRIPTION = 'PRODUCT_DESCRIPTION'
const	PRODUCTS_FROM_SEARCH = 'PRODUCTS_FROM_SEARCH'
	List of products in search result.
const	PRODUCTS_FROM_NAVIGATION = 'PRODUCTS_FROM_NAVIGATION'
	List of products in navigation.
const	PRODUCTS_UPSELL = 'PRODUCTS_UPSELL'
const	PRODUCTS_CROSS_SELL = 'PRODUCTS_CROSS_SELL'
const	PRODUCTS_RECOMMENDED = 'PRODUCTS_RECOMMENDED'
const	PRODUCTS_SIMILAR = 'PRODUCTS_SIMILAR'
const	PRODUCTS_VIEWED = 'PRODUCTS_VIEWED'
const	PRODUCTS_BOUGHT = 'PRODUCTS_BOUGHT'
SEO index
const	SEO_INDEX = 'SEO_INDEX'
User specific
const	USER_1 = 'USER_1'
const	USER_2 = 'USER_2'
const	USER_3 = 'USER_3'
const	USER_4 = 'USER_4'
const	USER_5 = 'USER_5'
const	USER_6 = 'USER_6'
const	USER_7 = 'USER_7'
const	USER_8 = 'USER_8'
const	USER_9 = 'USER_9'

Additional Inherited Members
Static Protected Member Functions inherited from BasicEnum
static	check_val ($instance, $value, $msg=null)
	Checks whether the value is valid.

Detailed Description

Defines various query origins.

Origin of the query is set automatically by the query itself or various helpers (such as AfsSpellcheckHelper). You are encouraged to set it manually when you do not use queries provided by the different available helpers.

Member Data Documentation

const CONCEPT = 'CONCEPT'

Query originates from one of the interpretation of the query.

This value is automatically set when one of the concept results is selected.

const DIRECT = 'DIRECT'

Direct access.

Direct access to specific item.

const FACET = 'FACET'

Query originates from facet value.

This value is automatically set when new filter value is set or removed.

const PAGER = 'PAGER'

Query originates from page change.

This value is automatically set when new result page is selected.

const PROMOTE = 'PROMOTE'

Query originates from advertisement.

This value is automatically set when one of the promote results is selected.

const RTE = 'RTE'

Query originates from related searches.

This value is automatically set when one of the related search results is selected.

const SEARCHBOX = 'SEARCHBOX'

Query originates from search box.

This value is automatically set when new search words are set to the query.

const SPELLCHECK = 'SPELLCHECK'

Query originates from spellcheck proposal.

This value is automatically for queries generated from spellcheck results.