eZPublishCommunityProject  2012.12
eZ\Publish\API\Repository\Values\Content\Query\Criterion\FullText Class Reference

Full text search criterion. More...

+ Inheritance diagram for eZ\Publish\API\Repository\Values\Content\Query\Criterion\FullText:
+ Collaboration diagram for eZ\Publish\API\Repository\Values\Content\Query\Criterion\FullText:

Public Member Functions

 __construct ($value)
 Creates a FullText criterion on $text, using the IN Operator. More...
 
 getSpecifications ()
 Criterion description function. More...
 
- Public Member Functions inherited from eZ\Publish\API\Repository\Values\Content\Query\Criterion
 __construct ($target, $operator, $value)
 Performs operator validation based on the Criterion specifications returned by {. More...
 

Static Public Member Functions

static createFromQueryBuilder ($target, $operator, $value)
 Creates a new Criterion for $target with operator $operator on $value. More...
 
- Static Public Member Functions inherited from eZ\Publish\API\Repository\Values\Content\Query\Criterion
static createFromQueryBuilder ($target, $operator, $value)
 

Additional Inherited Members

- Public Attributes inherited from eZ\Publish\API\Repository\Values\Content\Query\Criterion
 $operator
 
 $target
 
 $value
 

Detailed Description

Full text search criterion.

The string provided in this criterion is matched as a full text query against all indexed content objects in the storage layer.

Normalization and querying capabilities might depend on the system configuration or the used search engine and might differ. The following basic query seamtics are supported:

  • If multiple words are specified an AND query is performed. OR queries are not yet supported.
  • Simple wild cards are supported. If an asterisk (*) is used at the end or beginning of a word this is translated into a wild card query. Thus "fo*" would match "foo" and "foobar", for example.
  • Simple stop word removal might be applied to the words provided in the query.

Constructor & Destructor Documentation

eZ\Publish\API\Repository\Values\Content\Query\Criterion\FullText::__construct (   $value)

Creates a FullText criterion on $text, using the IN Operator.

Parameters
string$valueThe text to match on

Member Function Documentation

static eZ\Publish\API\Repository\Values\Content\Query\Criterion\FullText::createFromQueryBuilder (   $target,
  $operator,
  $value 
)
static

Creates a new Criterion for $target with operator $operator on $value.

Parameters
string$targetThe target (field identifier for a field, metadata identifier, etc)
string$operatorThe criterion operator, from Criterion
mixed$valueThe Criterion value, either as an individual item or an array
Returns
CriterionInterface

Implements eZ\Publish\API\Repository\Values\Content\Query\CriterionInterface.

eZ\Publish\API\Repository\Values\Content\Query\Criterion\FullText::getSpecifications ( )

Criterion description function.

Returns the combination of the Criterion's supported operator/value, as an array of eZ objects

  • Operator is one supported Operator, as an Operator::* constant
  • ValueType is the type of input value this operator requires, either array or single
  • SupportedTypes is an array of types the operator will accept
  • ValueCountLimitation is an integer saying how many values are expected.

// IN and EQ are supported return array( // The EQ operator expects a single value, either as an integer or a string new Specifications( Operator::EQ, Specifications::INPUT_TYPE_SINGLE, array( Specifications::INPUT_VALUE_INTEGER, Specifications::INPUT_VALUE_STRING ), ), // The IN operator expects an array of values, of either integers or strings new Specifications( Operator::IN, Specifications::INPUT_TYPE_ARRAY, array( Specifications::INPUT_VALUE_INTEGER, Specifications::INPUT_VALUE_STRING ) ) )*

Returns
[]

Implements eZ\Publish\API\Repository\Values\Content\Query\CriterionInterface.


The documentation for this class was generated from the following file: