Antidot PHP API  version 0.16.0
##PHP API to simplify integration of Antidot components
 All Classes Files Functions Variables Groups Pages
Public Member Functions | List of all members
AfsFacetDefault Class Reference

Manage parameter for all facets. More...

Inheritance diagram for AfsFacetDefault:
AfsQueryObjectInterface

Public Member Functions

 __construct (AfsFacetDefault $other=null)
 Constructs new AfsFacetDefault instance.
Facet values replies
 set_nb_replies ($nb_replies)
 Defines number of facet values in facet replies.
 get_nb_replies ()
 Retrieves maximum number of facet values in facet replies.
Facet values sort order
 set_sort_order ($mode, $order)
 Defines sort order for all facet values.
 get_sort_order ()
 Retrieves sort order defined on facet values.
Interface implementation
 copy ()
 Produces new instance copied from current one.
 format ()
 Format object to appropriate string form.

Detailed Description

Manage parameter for all facets.

Constructor & Destructor Documentation

__construct ( AfsFacetDefault  $other = null)

Constructs new AfsFacetDefault instance.

Parameters
$other[in] Other instance used to initialize newly created one (default: null, creates new instance from scratch).

Member Function Documentation

copy ( )

Produces new instance copied from current one.

Returns
copy of the current instance.

Implements AfsQueryObjectInterface.

format ( )

Format object to appropriate string form.

Returns
array of strings.

Implements AfsQueryObjectInterface.

get_nb_replies ( )

Retrieves maximum number of facet values in facet replies.

Returns
maximum number of facet values.
get_sort_order ( )

Retrieves sort order defined on facet values.

Returns
sort order or null when no sort sorder has been set.
set_nb_replies (   $nb_replies)

Defines number of facet values in facet replies.

Default number of facet values per facet is 1000. This value overrides default AFS search engine value which is 10.

Parameters
$nb_replies[in] Maximum number of facet values.
set_sort_order (   $mode,
  $order 
)

Defines sort order for all facet values.

AFS search default sort for facet values is alphanumeric. This method allows to change this behaviour.

Parameters
$mode[in] Sort mode (see AfsFacetValuesSortMode).
$order[in] Sort order (see AfsSortOrder).
Exceptions
InvalidArgumentExceptionwhen $mode or $order is invalid.