Important

You are browsing upcoming documentation for version 6.1 of OroCommerce, scheduled for release in 2025. Read the documentation for version 6.0 (the latest LTS version) to get up-to-date information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Query Builder

To perform search queries, you need to use the query builder => \Oro\Bundle\SearchBundle\Query\Query.

Example:

$query = (new Query())
        ->select('subject')
        ->from('acme_demo_question')
        ->andWhere('priority_id', '=', 1', 'integer')
        ->orWhere('priority_id', '>', 100, 'integer');

The syntax of Query builder is close to Doctrine 2.

• select() - accepts a string or array of strings representing field names in the search index. The values of those fields will be returned in the selected_data key of the response items. The select() parser will also accept SQL field name aliasing syntax, for example:

$query = (new Query())
        ->select('fieldvalue as name')

NOTE: If you do not want to overwrite the existing fields, use the addSelect() method. * from() - takes an array or string of entity aliases to search from. If the argument was *, then the search will be performed for all entities.

• andWhere(), orWhere() - functions set AND WHERE and OR WHERE functions in search request.

  • First argument - field name to search from. It can be set to * for searching by all fields.

  • Second argument - operators <, >, =, !=, etc. This parameter will be ignored if the first argument is for the text field.

  • Third argument - value to search

  • Fourth argument - field type.

• setFirstResult() - set the first result offset

• setMaxResults() - set max results of records in result.

As the result of the query, Oro\Bundle\SearchBundle\Query\Result will be returned with the information about the search query and result items.