SearchCriterion
class SearchCriterion implements SearchCriteriaInterface (View source)
Class SearchCriterion
Traits
A class that can be instantiated or replaced via DI
Constants
| EQUAL |
field:value |
| NOT_EQUAL |
-field:value |
| GREATER_EQUAL |
field:[value TO *] |
| GREATER_THAN |
field:{value TO *} |
| LESS_EQUAL |
field:[* TO value] |
| LESS_THAN |
field:{* TO value} |
| IN |
(field:value1 field:value2 field:value3) |
| NOT_IN |
-(field:value1 field:value2 field:value3) |
| ISNULL |
field:[ TO ] |
| ISNOTNULL |
-field:[ TO ] |
| CUSTOM |
A custom Criterion with it's own SearchQueryWriter |
Properties
| protected | string | $comparison | ||
| protected | string | $target | The table and field that this Criterion is applied to. |
|
| protected | mixed | $value | ||
| protected | SearchAdapterInterface | $adapter | ||
| protected | AbstractSearchQueryWriter | $searchQueryWriter |
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
No description
String values should be passed into our filter string with quotation marks and escaping.
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();
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).
__construct(string $target, string|array $value, string|null $comparison = null, AbstractSearchQueryWriter $searchQueryWriter = null)
No description
SearchAdapterInterface
getAdapter()
No description
$this
setAdapter(SearchAdapterInterface $adapter)
No description
void
appendPreparedStatementTo($ps)
No description
string
getQuoteValue(string $value)
String values should be passed into our filter string with quotation marks and escaping.
AbstractSearchQueryWriter
getSearchQueryWriter()
No description
$this
setSearchQueryWriter(AbstractSearchQueryWriter $searchQueryWriter)
No description
string
getComparison()
No description
protected $this
setComparison(string|null $comparison)
No description
string
getTarget()
No description
protected $this
setTarget(string $target)
No description
string|array
getValue()
No description
protected $this
setValue(string|array $value)
No description