Query Builder Reference

->andX

And composite constraint:

$ qb->where()
  ->andX()
    ->fieldIsset('f.foo')
    ->gt()->field('f.max')->literal(40)->end()
  ->end()
->end();

The andX node allows you to add 1, 2 or many operand nodes. When one operand is added the "and" is removed, when more than one is added the "and" operands are nested:

// when adding only a single operand,
$ qb->where()->andX()->eq()->field('f.foo')->literal('bar');
// is equivilent to:
$ qb->where()->eq()->field('f.foo')->literal('bar');


// when adding more than one,
$ qb->where()
  ->andX()
    ->fieldIsset('f.foo')
    ->gt()->field('f.max')->literal(40)->end()
    ->eq()->field('f.zar')->literal('bar')->end()
  ->end()
->end();

// is equivilent to:
$ qb->where()
  ->andX()
    ->fieldIsset('f.foo')
    ->andX()
      ->gt()->field('f.max')->literal(40)->end()
      ->eq()->field('f.zar')->litreal('bar')->end()
    ->end()
  ->end()
->end();

Adds: constraint (ConstraintAndx)

Returns: ConstraintAndx

->orX

Or composite constraint:

$ qb->where()
  ->orX()
    ->fieldIsset('sel_1.prop_1')
    ->fieldIsset('sel_1.prop_2')
  ->end()
->end();

As with "andX", "orX" allows one to many operands.

Adds: constraint (ConstraintOrx)

Returns: ConstraintOrx

->fieldIsset

Field existance constraint:

$ qb->where()->fieldIsset('sel_1.prop_1')->end();

Adds: constraint (ConstraintFieldIsset)

Returns: ConstraintFactory

Arguments:

• $field: string - Field to check

->fullTextSearch

Full text search constraint:

$ qb->where()->fullTextSearch('sel_1.prop_1', 'search_expression')->end();

Adds: constraint (ConstraintFullTextSearch)

Returns: ConstraintFactory

Arguments:

• $field: string - Name of field to check, including alias name.
• $fullTextSearchExpression: string - Search expression.

->same

Same document constraint:

$ qb->where()->same('/path/to/doc', 'sel_1')->end();

Relates to PHPCR QOM SameNodeInterface.

Adds: constraint (ConstraintSame)

Returns: ConstraintFactory

Arguments:

• $path: string - Path to reference document.
• $alias: string - Name of alias to use.

->descendant

Descendant document constraint:

$ qb->where()->descendant('/ancestor/path', 'sel_1')->end();

Relates to PHPCR QOM DescendantNodeInterface

Adds: constraint (ConstraintDescendant)

Returns: ConstraintFactory

Arguments:

• $ancestorPath: string - Select descendants of this path.
• $alias: string - Name of alias to use.

->child

Select children of the aliased document at the given path:

$ qb->where()->child('/parent/path', 'sel_1')->end();

Relates to PHPCR QOM ChildNodeInterface.

Adds: constraint (ConstraintChild)

Returns: ConstraintFactory

Arguments:

• $parentPath: string - Select children of this path.
• $alias: string - Name of alias to use

->eq

Equality comparison constraint:

$ qb->where()
  ->eq()
    ->field('sel_1.foobar')
    ->literal('var_1')
  ->end();

Adds: constraint (ConstraintComparison)

Returns: ConstraintComparison

->neq

Inequality comparison constraint:

$ qb->where()
  ->neq()
    ->field('sel_1.foobar')
    ->literal('var_1')
  ->end();

Adds: constraint (ConstraintComparison)

Returns: ConstraintComparison

->lt

Less than comparison constraint:

$ qb->where()
  ->lt()
    ->field('sel_1.foobar')
    ->literal(5)
  ->end();

Adds: constraint (ConstraintComparison)

Returns: ConstraintComparison

->lte

Less than or equal to comparison constraint:

$ qb->where()
  ->lte()
    ->field('sel_1.foobar')
    ->literal(5)
  ->end();

Adds: constraint (ConstraintComparison)

Returns: ConstraintComparison

->gt

Greater than comparison constraint:

$ qb->where()
  ->gt()
    ->field('sel_1.foobar')
    ->literal(5)
  ->end();

Adds: constraint (ConstraintComparison)

Returns: ConstraintComparison

->gte

Greater than or equal to comparison constraint:

$ qb->where()
  ->gte()
    ->field('sel_1.foobar')
    ->literal(5)
  ->end();

Adds: constraint (ConstraintComparison)

Returns: ConstraintComparison

->like

Like comparison constraint.

Use "%" as wildcards:

$ qb->where()
  ->like()
    ->field('sel_1.foobar')
    ->literal('foo%')
  ->end();

The above example will match "foo" and "foobar" but not "barfoo".

Adds: constraint (ConstraintComparison)

Returns: ConstraintComparison

->fullTextSearchScore

Represents the aliased documents rank by relevance to the full text search expression given by the "fullTextSearch" constraint:

$ qb->where()
  ->gt()
    ->fullTextSearchScore('sel_1')
    ->literal(50)
  ->end()
->end();

$ qb->orderBy()
  ->asc()->fullTextSearchScore('sel_1')
->end();

See also: http://www.day.com/specs/jcr/2.0/6_Query.html#FullTextSearchScore

Adds: operand_dynamic (OperandDynamicFullTextSearchScore)

Returns: OperandDynamicFactory

Arguments:

• $alias: string - Name of alias to use

->length

Length operand resolves to length of aliased document:

$ qb->where()
  ->gt()
    ->length('alias_1.prop_1')
    ->literal(50)
  ->end()
->end();

$ qb->orderBy()->asc()->fullTextSearchScore('sel_1')->end();

Adds: operand_dynamic (OperandDynamicLength)

Returns: OperandDynamicFactory

Arguments:

• $field: string - Name of field to check.

->lowerCase

LowerCase operand evaluates to lower-cased string of child operand:

$ qb->where()
  ->eq()
    ->lowerCase()->field('sel_1.prop_1')->end()
    ->literal('lower_case')
  ->end()
->end();

Adds: operand_dynamic (OperandDynamicLowerCase)

Returns: OperandDynamicLowerCase

->upperCase

UpperCase operand evaluates to upper-cased string of child operand:

$ qb->where()
  ->eq()
      ->upperCase()->field('sel_1.prop_1')->end()
      ->literal('UPPER_CASE')
  ->end()
->end();

Adds: operand_dynamic (OperandDynamicUpperCase)

Returns: OperandDynamicUpperCase

->localName

Document local name evaluates to the local (non namespaced) name of the node being compared.

For example, if a node has the path "/path/to/foobar", then "foobar" is the local node name:

$ qb->where()
  ->eq()
    ->localName('sel_1')
    ->literal('my_node_name')
  ->end()
->end();

Relates to PHPCR NodeLocalNameInterface

Adds: operand_dynamic (OperandDynamicLocalName)

Returns: OperandDynamicFactory

Arguments:

• $alias: string - Name of alias to use

->name

Evaluates to the namespaced name of the node being compared.

For example, if a node has the path "/path/to/bar:foobar", then "bar:foobar" is the namespaced node name:

$ qb->where()
  ->eq()
    ->name('sel_1')
    ->literal('namespace:my_node_name')
  ->end()
->end();

Relates to PHPCR NodeNameInterface.

Adds: operand_dynamic (OperandDynamicName)

Returns: OperandDynamicFactory

Arguments:

• $alias: string - Name of alias to use

->field

Evaluates to the value of the specified field:

$ qb->where()
  ->eq()
    ->field('sel_1.prop_name')
    ->literal('my_field_value')
  ->end()
->end();

Adds: operand_dynamic (OperandDynamicField)

Returns: OperandDynamicFactory

Arguments:

• $field: string - name of field to check, including alias name.

->parameter

Evaluates to the value of the parameter bound to the given $name.

Relates to PHPCR BindVariableValueInterface:

$ qb->where()->eq()->field('f.foobar')->parameter('param_1')->end();
$ qb->setParameter('param_1', 'foo');

Adds: operand_static (OperandStaticParameter)

Returns: OperandFactory

Arguments:

• $name: string - Name of parameter to resolve.

->literal

Evaluates to the given literal value:

$ qb->where()->eq()->field('f.foobar')->literal('Literal Value')->end();

Adds: operand_static (OperandStaticLiteral)

Returns: OperandStaticLiteral

Arguments:

• $value: string - Literal value.

->asc

Add ascending ordering:

$ qb->orderBy()->asc()->field('sel_1.prop_1')->end();

Adds: ordering (Ordering)

Returns: Ordering

->desc

Add descending ordering:

$ qb->orderBy()->desc()->field('sel_1.prop_1')->end();

Adds: ordering (Ordering)

Returns: Ordering

->where

Where factory node is used to specify selection criteria:

$ qb->where()
  ->eq()
    ->field('a.foobar')->literal('bar')->end()
  ->end()
->end();

Adds: where (Where)

Returns: Where

->andWhere

Add additional selection criteria using the AND operator.

Adds: where (WhereAnd)

Returns: WhereAnd

->orWhere

Add additional selection criteria using the OR operator.

Adds: where (WhereOr)

Returns: WhereOr

->from

Set the from source for the query:

$ qb->from()->document('Foobar', 'a');

// or with a join ...

$ qb->from('a')->joinInner()
  ->left()->document('Foobar', 'a')->end()
  ->right()->document('Barfoo', 'b')->end()
  ->condition()->equi('a.prop_1', 'b.prop_1')->end()
->end();

Adds: from (From)

Returns: From

Arguments:

• $primaryAlias: string - Alias to use as primary source (optional for single sources)

->fromDocument

Shortcut for:

$ qb->from()
  ->document('Foobar', 'a')->end()
->end();

Which becomes:

$ qb->fromDocument('Foobar', 'a')->end();

Replaces any existing from source.

Adds: from (From)

Returns: QueryBuilder

Arguments:

• $documentFqn: string - Fully qualified class name for document.
• $primaryAlias: string - Alias for document source and primary alias when using multiple sources.

->addJoinLeftOuter

Replace the existing source with a left outer join source using the existing source as the left operand:

$ qb->fromDocument('Foobar', 'a')
  ->addJoinLeftOuter()
    ->right()->document('Barfoo', 'b')->end()
    ->condition()->equi('a.prop_1', 'b.prop_2')->end()
  ->end()
->end();

Note that for outer joins to work correctly, documents being joined to must be mapped with a node type that is unique to the repository workspace, and the uniqueNodeType property must be set to true for the document (see #[Document]). Otherwise, the join will behave as an inner join.

Adds: select (Select)

Returns: SourceJoin

->addJoinRightOuter

Replace the existing source with a right outer join source using the existing source as the left operand:

$ qb->fromDocument('Foobar', 'a')
  ->addJoinRightOuter()
    ->right()->document('Barfoo', 'b')->end()->end()
    ->condition()->equi('a.prop_1', 'b.prop_2')->end()
  ->end()
->end();

Note that for outer joins to work correctly, documents being joined to must be mapped with a node type that is unique to the repository workspace, and the uniqueNodeType property must be set to true for the document (see #[Document]). Otherwise, the join will behave as an inner join.

Adds: select (Select)

Returns: SourceJoin

->addJoinInner

Replace the existing source with an inner join source using the existing source as the left operand:

$ qb->fromDocument('Foobar', 'a')
  ->addJoinInner()
    ->right()->document('Barfoo', 'b')->end()
    ->condition()->equi('a.prop_1', 'b.prop_2')->end()
  ->end()
->end();

Note that for outer joins to work correctly, documents being joined to must be mapped with a node type that is unique to the repository workspace, and the uniqueNodeType property must be set to true for the document (see #[Document]). Otherwise, the join will behave as an inner join.

Adds: select (Select)

Returns: SourceJoin

->select

Method to add properties for selection to builder tree, replaces any existing select.

Number of property nodes is unbounded:

$ qb->select()
  ->field('a.prop_1')
  ->field('a.prop_2')
  ->field('a.prop_3')
->end();

Adds: select (Select)

Returns: Select

->addSelect

Add additional properties to selection:

$ qb->select()
    ->field('a.prop_1')
  ->end()
  ->addSelect()
    ->field('a.prop_2')
    ->field('a.prop_3')
    ->field('a.prop_4')
  ->end();

Adds: select (SelectAdd)

Returns: SelectAdd

->orderBy

Add orderings to the builder tree.

Number of orderings is unbounded:

$ qb->orderBy()
  ->asc()->field('a.prop_1')->end()
  ->desc()->field('a.prop_2')->end()
->end();

Adds: order_by (OrderBy)

Returns: OrderBy

->addOrderBy

Add additional orderings to the builder tree.

Adds: order_by (OrderByAdd)

Returns: OrderByAdd

->descendant

Descendant join condition:

$ qb->from('alias_1')
  ->joinInner()
    ->left()->document('Foo/Bar/One', 'alias_1')->end()
    ->right()->document('Foo/Bar/Two', 'alias_2')->end()
    ->condition()
      ->descendant('alias_1', 'alias_2')
    ->end()
->end();

Adds: source_join_condition (SourceJoinConditionDescendant)

Returns: SourceJoinConditionFactory

Arguments:

• $descendantAlias: string - Name of alias for descendant documents.
• $ancestorAlias: string - Name of alias to match for ancestor documents.

->equi

Equi (equality) join condition:

 $qb->from('alias_1')
   ->joinInner()
     ->left()->document('Foo/Bar/One', 'alias_1')->end()
     ->right()->document('Foo/Bar/Two', 'alias_2')->end()
     ->condition()->equi('alias_1.prop_1', 'alias_2.prop_2')
   ->end()
->end();

See: http://en.wikipedia.org/wiki/Join_%28SQL%29#Equi-join

Adds: source_join_condition (SourceJoinConditionEqui)

Returns: SourceJoinConditionFactory

Arguments:

• $field1: string - Field name for first field.
• $field2: string - Field name for second field.

->child

Child document join condition:

 $qb->from('alias_1')
   ->joinInner()
     ->left()->document('Foo/Bar/One', 'alias_1')->end()
     ->right()->document('Foo/Bar/Two', 'alias_2')->end()
     ->condition()->child('alias_1', 'alias_2')->end()
   ->end()
->end();

Adds: source_join_condition (SourceJoinConditionChildDocument)

Returns: SourceJoinConditionFactory

Arguments:

• $childAlias: string - Name of alias for child documents.
• $parentAlias: string - Name of alias to match for parent documents.

->same

Same document join condition:

$ qb->from('alias_1')
  ->joinInner()
    ->left()->document('Foo/Bar/One', 'alias_1')->end()
    ->right()->document('Foo/Bar/Two', 'alias_2')->end()
    ->condition()
      ->same('alias_1', 'alias_2', '/path_to/alias_2/document')
    ->end()
  ->end()
->end();

Adds: source_join_condition (SourceJoinConditionSameDocument)

Returns: SourceJoinConditionFactory

Arguments:

• $alias1: string - Name of first alias.
• $alias2: string - Name of first alias.
• $alias2Path: string - Path for documents of second alias.