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
AfsFacetElementBuilder Class Reference

Helper to build facet elements. More...

Public Member Functions

 __construct (AfsFacetManager $facet_mgr, AfsQuery $query)
 Constructs new instance of facet element builder.
 create_elements ($facet_id, $facet_element, AfsHelperConfiguration $config, $feed=null)
 Creates recursively facet elements.

Detailed Description

Helper to build facet elements.

Facet elements are built recursively when necessary.

Constructor & Destructor Documentation

__construct ( AfsFacetManager  $facet_mgr,
AfsQuery  $query 
)

Constructs new instance of facet element builder.

Parameters
$facet_mgr[in] in conjunction with query, it is used to produce adequate query for each facet element.
$query[in] query which has led to current reply state.

Member Function Documentation

create_elements (   $facet_id,
  $facet_element,
AfsHelperConfiguration  $config,
  $feed = null 
)

Creates recursively facet elements.

Parameters
$facet_id[in] current facet id. This value is used to update current query for each facet element.
$facet_element[in] starting point used to create facet elements.
$config[in] helper configuration object.
Returns
list of facet elements (see @ AfsFacetValueHelper).