class SolrSearchQueryWriterRange extends AbstractSearchQueryWriter (View source)

Class SolrSearchQueryWriter_Range

Traits

A class that can be instantiated or replaced via DI

Methods

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

public
string
generateQueryString(SearchCriterion $searchCriterion)

No description

protected
string
getComparisonPolarity(string $comparison)

Is this a positive (+) or negative (-) Solr comparison.

protected
mixed|string
getLeftComparison(SearchCriterion $searchCriterion)

Select the value that we want as our left comparison value.

protected
mixed|string
getRightComparison(SearchCriterion $searchCriterion)

Select the value that we want as our right comparison value.

protected
string
getComparisonConjunction()

Decide how we are comparing our left and right values.

protected
string
getOpenComparisonContainer(string $comparison)

Does our comparison need a container? EG: "[ TO ]"? If so, return the opening container brace.

protected
string
getCloseComparisonContainer(string $comparison)

Does our comparison need a container? EG: "[ TO ]"? If so, return the closing container brace.

Details

static Injectable create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

mixed ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

string generateQueryString(SearchCriterion $searchCriterion)

No description

Parameters

SearchCriterion $searchCriterion

Return Value

string

protected string getComparisonPolarity(string $comparison)

Is this a positive (+) or negative (-) Solr comparison.

Parameters

string $comparison

Return Value

string

protected mixed|string getLeftComparison(SearchCriterion $searchCriterion)

Select the value that we want as our left comparison value.

Parameters

SearchCriterion $searchCriterion

Return Value

mixed|string

Exceptions

InvalidArgumentException

protected mixed|string getRightComparison(SearchCriterion $searchCriterion)

Select the value that we want as our right comparison value.

Parameters

SearchCriterion $searchCriterion

Return Value

mixed|string

Exceptions

InvalidArgumentException

protected string getComparisonConjunction()

Decide how we are comparing our left and right values.

Return Value

string

protected string getOpenComparisonContainer(string $comparison)

Does our comparison need a container? EG: "[ TO ]"? If so, return the opening container brace.

Parameters

string $comparison

Return Value

string

Exceptions

InvalidArgumentException

protected string getCloseComparisonContainer(string $comparison)

Does our comparison need a container? EG: "[ TO ]"? If so, return the closing container brace.

Parameters

string $comparison

Return Value

string

Exceptions

InvalidArgumentException