RefineBar class - Documentation for SproutCMS

Info Page:

Page options:

class RefineBar

Provides the search refinement options in the admin UI

Name	Visibility	Description
addWidget	public	Add a refine widget
get	public	Gets the bar
getGroups	public	Return a list of search widgets, in groups
getOperator	public	Return the operator to use in WHERE clauses, for a given field
hasField	public	Returns true if any of the refine bar widgets refer to the specified field
render	public	Renders the bar
setGroup	public

void $RefineBar->addWidget ( RefineWidget $widget [, string $operator ] );

Add a refine widget

unknown $RefineBar->get ( );

Gets the bar

unknown $RefineBar->getGroups ( );

Return a list of search widgets, in groups

null|string $RefineBar->getOperator ( string $field_name );

Return the operator to use in WHERE clauses, for a given field

unknown $RefineBar->hasField ( mixed $field_name );

Returns true if any of the refine bar widgets refer to the specified field

void $RefineBar->render ( );

Renders the bar

void $RefineBar->setGroup ( mixed $name );

This function does not have a description