AfsFeed Class Reference

Public Member Functions
	get_name ()
	is_activated ()
	set_activated ($activated)
	to set this feed activated for query (eg. afs:feed parameter in query string)
	add_parameters ($params)
	add a new query parameter to applied on current feed
	get_parameter ($key)
	retrieve a parameter from is key
	add_sort ($sort_name, $order)
	add sort parameter on current feed
	has_sort ($sort_name)
	check if sort_nmae is set on this feed
	get_sort ()
	get formated sort string (eg. facetId,sortOrder;facetId1,sortOrder; ...)
	get_sorts ()
	retrieve sort parameter list
	set_sort ($key, $order)
	set a new sort parameter, replacing existing one
	has_filter ($facet_id, $value)
	check if a filter is set on this feed
	add_filter ($facet_id, $values)
	remove_filter ($facet_id, $value)
	remove a filter already set on this feed
	get_filter_values ($facet_id)
	set_filter ($facet_id, $values)
	get_filters ()
	get_facet_ids ()
	set_filters (array $filters)
	format ()
	get_parameters (array $parameter_list)

Member Function Documentation

add_filter	(		$facet_id,
			$values
	)

@ add a new filter on this feed

Parameters

$facet_id
$values

add_parameters

(

$params

)

add a new query parameter to applied on current feed

Parameters

$params

add_sort	(		$sort_name,
			$order
	)

add sort parameter on current feed

Parameters

$sort_name
$order

format

(

)

Returns

mixed

get_facet_ids

(

)

Returns

array

get_filter_values

(

$facet_id

)

Parameters

$facet_id

Exceptions

AfsFilterException

get_filters

(

)

Returns

array

get_name

(

)

Returns

feed name

get_parameter

(

$key

)

retrieve a parameter from is key

Parameters

$key	the key of parameter to get

Returns

the parameter (AfsQueryParameter)if exists, otherwise null

get_parameters

(

array

$parameter_list

)

Parameters

array

$parameter_list

Returns

array

get_sort

(

)

get formated sort string (eg. facetId,sortOrder;facetId1,sortOrder; ...)

Returns

string

get_sorts

(

)

retrieve sort parameter list

Returns

array

has_filter	(		$facet_id,
			$value
	)

check if a filter is set on this feed

Parameters

$facet_id
$value

Returns

true is filter is set, false otherwise

has_sort

(

$sort_name

)

check if sort_nmae is set on this feed

Parameters

$sort_name

Returns

true if $sort_name is set, otherwise false

is_activated

(

)

Returns

true if feed is activated for this request (eg; will be generate a afs:feed parameter in query string)

remove_filter	(		$facet_id,
			$value
	)

remove a filter already set on this feed

Parameters

$facet_id
$value

set_activated

(

$activated

)

to set this feed activated for query (eg. afs:feed parameter in query string)

Parameters

$activated

set_filter	(		$facet_id,
			$values
	)

Parameters

$facet_id
$values

set_filters

(

array

$filters

)

Parameters

array

$filters

set_sort	(		$key,
			$order
	)

set a new sort parameter, replacing existing one

Parameters

array

$sort