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 | Public Attributes | List of all members
AfsFacetValuesSortOrder Class Reference

Facet values sort order. More...

Public Member Functions

 __construct ($mode, $order)
 Constructs new instance with appropriate sort mode/order.
 copy ()
 Copies current instance.
 format ()
 Format instance as array of sort mode then sort order.

Public Attributes

 $mode = null
 Sort order mode.
 $order = null
 Sort order.

Detailed Description

Facet values sort order.

Constructor & Destructor Documentation

__construct (   $mode,
  $order 
)

Constructs new instance with appropriate sort mode/order.

Parameters
$mode[in] Sort mode (see AfsFacetValuesSortMode for details).
$order[in] Sort order (see AfsSortOrder for details).

Member Function Documentation

copy ( )

Copies current instance.

Returns
new instance, copy of current one.
format ( )

Format instance as array of sort mode then sort order.

Returns
formatted array.

Member Data Documentation

$mode = null

Sort order mode.

See AfsFacetValuesSortMode for available values.

$order = null

Sort order.

See AfsSortOrder for available values.