tflori/orm

» API Reference » ORM\Testing\EntityFetcherMock\Result

ORM\Testing\EntityFetcherMock\Result

Table of Contents

• Abstract
• Properties
• Methods
  • $result->__construct - Constructor
  • $result->addEntities - Add entities to the result
  • $result->all - Fetch an array of entities
  • $result->andParenthesis - Add a parenthesis with AND
  • $result->andWhere - Add a where condition with AND.
  • $result->close - Close parenthesis
  • $result->column - Add $column
  • $result->columns - Set $columns
  • $result->compare - Check if $fetcher matches the current query
  • $result->count - Get the count of the resulting items
  • $result->createRelatedJoin - Create the join with $join type
  • $result->delete - Execute a delete statement on the current table with current where conditions
  • $result->filter - Apply an additional $filter before executing
  • $result->fullJoin -
  • $result->getEntities - Get the entities for this result
  • $result->getEntityManager -
  • $result->getExpression - Get the expression
  • Result::getGlobalFilters - Get the filters registered for $class
  • $result->getQuery - Get the query / select statement
  • $result->groupBy - Group By $column
  • $result->insert - Execute an insert statement on the current table
  • $result->join -
  • $result->joinRelated - Join $relation
  • $result->leftJoin -
  • $result->leftJoinRelated - Left outer join $relation
  • $result->limit - Set $limit
  • $result->matches - Add a regular expression that has to match
  • $result->modifier - Add $modifier
  • $result->offset - Set $offset
  • $result->one - Fetch one entity
  • $result->orderBy - Order By $column in $direction
  • $result->orParenthesis - Add a parenthesis with OR
  • $result->orWhere - Add a where condition with OR.
  • $result->orWhereIn - Add a where in condition with OR.
  • $result->orWhereNotIn - Add a where not in condition with OR.
  • $result->parenthesis - Alias for andParenthesis
  • Result::registerGlobalFilter - Register $filter globally for $class
  • $result->reset - Reset the position of the cursor to the first row
  • $result->rightJoin -
  • $result->setFetchMode - Proxy to PDOStatement::setFetchMode()
  • $result->setQuery - Set a raw query or use different QueryBuilder
  • $result->update - Execute an update statement for the current query
  • $result->where - Alias for andWhere
  • $result->whereIn - Add a where in condition with AND.
  • $result->whereNotIn - Add a where not in condition with AND.
  • $result->with - Load $relations after all objects are loaded
  • $result->withoutFilter - Exclude $filterClass for this fetcher

Abstract

Extends: ORM\EntityFetcher

Fetch entities from database

If you need more specific queries you write them yourself. If you need just more specific where clause you can pass them to the *where() methods.

Supported:

• joins with on clause (and alias)
• joins with using (and alias)
• where conditions
• parenthesis
• order by one or more columns / expressions
• group by one or more columns / expressions
• limit and offset
• modifiers

Properties

Methods

ORM\Testing\EntityFetcherMock\Result::__construct

public function __construct(
    \ORM\EntityManager $entityManager, 
    \ORM\Entity|string $class, 
)

Constructor

Parameters

ORM\Testing\EntityFetcherMock\Result::__construct

↑ top

ORM\Testing\EntityFetcherMock\Result::addEntities

public function addEntities(\ORM\Entity[] $entities): $this

Add entities to the result

Parameters

ORM\Testing\EntityFetcherMock\Result::addEntities

↑ top

ORM\Testing\EntityFetcherMock\Result::all

public function all(int $limit): \ORM\Entity[]

Fetch an array of entities

When no $limit is set it fetches all entities in result set.

Parameters

ORM\Testing\EntityFetcherMock\Result::all

↑ top

ORM\Testing\EntityFetcherMock\Result::andParenthesis

public function andParenthesis(): $this

Add a parenthesis with AND

ORM\Testing\EntityFetcherMock\Result::andParenthesis

↑ top

ORM\Testing\EntityFetcherMock\Result::andWhere

public function andWhere(
    string $column, 
    string|array $operator = null, 
    string $value = null, 
): $this

Add a where condition with AND.

QueryBuilderInterface andWhere($column[, $operator[, $value]]);

If $column has the same amount of question marks as $value - $value is the second parameter.

If there is no third parameter and no question mark in $column then the default operator is ‘=’ and $value is the second parameter.

These calls are equal:

$query->andWhere('name', '=' , 'John Doe');
$query->andWhere('name = ?', 'John Doe');
$query->andWhere('name', 'John Doe');
$query->andWhere('name = ?', ['John Doe']);

Parameters

ORM\Testing\EntityFetcherMock\Result::andWhere

↑ top

ORM\Testing\EntityFetcherMock\Result::close

public function close(
    , 
): \ORM\QueryBuilder\QueryBuilderInterface|\ORM\QueryBuilder\ParenthesisInterface

Close parenthesis

ORM\Testing\EntityFetcherMock\Result::close

↑ top

ORM\Testing\EntityFetcherMock\Result::column

public function column(
    mixed $column, 
    mixed $args = [], 
    mixed $alias = '', 
): $this

Add $column

Parameters

ORM\Testing\EntityFetcherMock\Result::column

↑ top

ORM\Testing\EntityFetcherMock\Result::columns

public function columns(array $columns = null): $this

Set $columns

Parameters

ORM\Testing\EntityFetcherMock\Result::columns

↑ top

ORM\Testing\EntityFetcherMock\Result::compare

public function compare(\ORM\EntityFetcher $fetcher): int

Check if $fetcher matches the current query

Returns the score for the given EntityFetcher. The more conditions match the higher the score:

• 0 = the query does not match one of the conditions
• 1 = no conditions required to match the query
• n = n-1 conditions matched the query

Parameters

ORM\Testing\EntityFetcherMock\Result::compare

↑ top

ORM\Testing\EntityFetcherMock\Result::count

public function count(): int

Get the count of the resulting items

ORM\Testing\EntityFetcherMock\Result::count

↑ top

ORM\Testing\EntityFetcherMock\Result::createRelatedJoin

public function createRelatedJoin(mixed $join, mixed $relation): $this

Create the join with $join type

Parameters

ORM\Testing\EntityFetcherMock\Result::createRelatedJoin

↑ top

ORM\Testing\EntityFetcherMock\Result::delete

public function delete(): int

Execute a delete statement on the current table with current where conditions

ORM\Testing\EntityFetcherMock\Result::delete

↑ top

ORM\Testing\EntityFetcherMock\Result::filter

public function filter(
    string|\ORM\EntityFetcher\FilterInterface|callable $filter, 
): $this

Apply an additional $filter before executing

Parameters

ORM\Testing\EntityFetcherMock\Result::filter

↑ top

ORM\Testing\EntityFetcherMock\Result::fullJoin

public function fullJoin(
    mixed $class, 
    mixed $expression = '', 
    mixed $alias = '', 
    mixed $args = [], 
): mixed

Parameters

ORM\Testing\EntityFetcherMock\Result::fullJoin

↑ top

ORM\Testing\EntityFetcherMock\Result::getEntities

public function getEntities(): \ORM\Entity[]

Get the entities for this result

ORM\Testing\EntityFetcherMock\Result::getEntities

↑ top

ORM\Testing\EntityFetcherMock\Result::getEntityManager

public function getEntityManager(): \ORM\EntityManager

ORM\Testing\EntityFetcherMock\Result::getEntityManager

↑ top

ORM\Testing\EntityFetcherMock\Result::getExpression

public function getExpression(): string

Get the expression

ORM\Testing\EntityFetcherMock\Result::getExpression

↑ top

ORM\Testing\EntityFetcherMock\Result::getGlobalFilters

public static function getGlobalFilters(string $class): array

Get the filters registered for $class

A filter can be registered for the super class too.

Parameters

ORM\Testing\EntityFetcherMock\Result::getGlobalFilters

↑ top

ORM\Testing\EntityFetcherMock\Result::getQuery

public function getQuery(): string

Get the query / select statement

ORM\Testing\EntityFetcherMock\Result::getQuery

↑ top

ORM\Testing\EntityFetcherMock\Result::groupBy

public function groupBy(mixed $column, mixed $args = []): $this

Group By $column

Parameters

ORM\Testing\EntityFetcherMock\Result::groupBy

↑ top

ORM\Testing\EntityFetcherMock\Result::insert

public function insert(array $rows): int

Execute an insert statement on the current table

Parameters

ORM\Testing\EntityFetcherMock\Result::insert

↑ top

ORM\Testing\EntityFetcherMock\Result::join

public function join(
    mixed $class, 
    mixed $expression = '', 
    mixed $alias = '', 
    mixed $args = [], 
): mixed

Parameters

ORM\Testing\EntityFetcherMock\Result::join

↑ top

ORM\Testing\EntityFetcherMock\Result::joinRelated

public function joinRelated(mixed $relation): $this

Join $relation

Parameters

ORM\Testing\EntityFetcherMock\Result::joinRelated

↑ top

ORM\Testing\EntityFetcherMock\Result::leftJoin

public function leftJoin(
    mixed $class, 
    mixed $expression = '', 
    mixed $alias = '', 
    mixed $args = [], 
): mixed

Parameters

ORM\Testing\EntityFetcherMock\Result::leftJoin

↑ top

ORM\Testing\EntityFetcherMock\Result::leftJoinRelated

public function leftJoinRelated(mixed $relation): $this

Left outer join $relation

Parameters

ORM\Testing\EntityFetcherMock\Result::leftJoinRelated

↑ top

ORM\Testing\EntityFetcherMock\Result::limit

public function limit(mixed $limit): $this

Set $limit

Parameters

ORM\Testing\EntityFetcherMock\Result::limit

↑ top

ORM\Testing\EntityFetcherMock\Result::matches

public function matches(string $expression): $this

Add a regular expression that has to match

Parameters

ORM\Testing\EntityFetcherMock\Result::matches

↑ top

ORM\Testing\EntityFetcherMock\Result::modifier

public function modifier(mixed $modifier): $this

Add $modifier

Parameters

ORM\Testing\EntityFetcherMock\Result::modifier

↑ top

ORM\Testing\EntityFetcherMock\Result::offset

public function offset(mixed $offset): $this

Set $offset

Parameters

ORM\Testing\EntityFetcherMock\Result::offset

↑ top

ORM\Testing\EntityFetcherMock\Result::one

public function one(): \ORM\Entity

Fetch one entity

If there is no more entity in the result set it returns null.

ORM\Testing\EntityFetcherMock\Result::one

↑ top

ORM\Testing\EntityFetcherMock\Result::orderBy

public function orderBy(
    mixed $column, 
    mixed $direction = self::DIRECTION_ASCENDING, 
    mixed $args = [], 
): $this

Order By $column in $direction

Parameters

ORM\Testing\EntityFetcherMock\Result::orderBy

↑ top

ORM\Testing\EntityFetcherMock\Result::orParenthesis

public function orParenthesis(): $this

Add a parenthesis with OR

ORM\Testing\EntityFetcherMock\Result::orParenthesis

↑ top

ORM\Testing\EntityFetcherMock\Result::orWhere

public function orWhere(
    string $column, 
    string|array $operator = null, 
    string $value = null, 
): $this

Add a where condition with OR.

QueryBuilderInterface orWhere($column[, $operator[, $value]]);

If $column has the same amount of question marks as $value - $value is the second parameter.

If there is no third parameter and no question mark in $column then the default operator is ‘=’ and $value is the second parameter.

These calls are equal:

$query->orWhere('name', '=' , 'John Doe');
$query->orWhere('name = ?', 'John Doe');
$query->orWhere('name', 'John Doe');
$query->orWhere('name = ?', ['John Doe']);

Parameters

ORM\Testing\EntityFetcherMock\Result::orWhere

↑ top

ORM\Testing\EntityFetcherMock\Result::orWhereIn

public function orWhereIn(string|array $column, array $values): $this

Add a where in condition with OR.

If $column is an array a composite where in statement will be created

Example: whereIn(['a', 'b'], [[42, 23], [42, 23]]) gets (a,b) IN ((42,23), (23,42)) in mysql

If $values is empty the expression will be 1 = 0 because an empty parenthesis causes an error in SQL.

Parameters

ORM\Testing\EntityFetcherMock\Result::orWhereIn

↑ top

ORM\Testing\EntityFetcherMock\Result::orWhereNotIn

public function orWhereNotIn(string|array $column, array $values): $this

Add a where not in condition with OR.

If $column is an array a composite where in statement will be created

Example: whereIn(['a', 'b'], [[42, 23], [42, 23]]) gets (a,b) NOT IN ((42,23), (23,42)) in mysql

If $values is empty the expression will be 1 = 1 because an empty parenthesis causes an error in SQL.

Parameters

ORM\Testing\EntityFetcherMock\Result::orWhereNotIn

↑ top

ORM\Testing\EntityFetcherMock\Result::parenthesis

public function parenthesis(): $this

Alias for andParenthesis

ORM\Testing\EntityFetcherMock\Result::parenthesis

↑ top

ORM\Testing\EntityFetcherMock\Result::registerGlobalFilter

public static function registerGlobalFilter(
    mixed $class, 
    string|\ORM\EntityFetcher\FilterInterface|callable $filter, 
): mixed

Register $filter globally for $class

A registered filter will be applied in all entity fetchers for the class if not excluded by $fetcher->withoutFilter(Filter::class).

Parameters

ORM\Testing\EntityFetcherMock\Result::registerGlobalFilter

↑ top

ORM\Testing\EntityFetcherMock\Result::reset

public function reset(): $this

Reset the position of the cursor to the first row

ORM\Testing\EntityFetcherMock\Result::reset

↑ top

ORM\Testing\EntityFetcherMock\Result::rightJoin

public function rightJoin(
    mixed $class, 
    mixed $expression = '', 
    mixed $alias = '', 
    mixed $args = [], 
): mixed

Parameters

ORM\Testing\EntityFetcherMock\Result::rightJoin

↑ top

ORM\Testing\EntityFetcherMock\Result::setFetchMode

public function setFetchMode(
    int $mode, 
    int|string|object $classNameObject = null, 
    array $constructorArgs = null, 
): $this

Proxy to PDOStatement::setFetchMode()

Please note that this will execute the query - further modifications will not have any effect.

Parameters

See Also:

• PDOStatement::setFetchMode() - php manual

ORM\Testing\EntityFetcherMock\Result::setFetchMode

↑ top

ORM\Testing\EntityFetcherMock\Result::setQuery

public function setQuery(
    string|\ORM\QueryBuilder\QueryBuilderInterface $query, 
    array $args = null, 
): $this

Set a raw query or use different QueryBuilder

For easier use and against sql injection it allows question mark placeholders.

Please be aware that this query is not touched at all and neither filters nor where conditions are applied.

Parameters

ORM\Testing\EntityFetcherMock\Result::setQuery

↑ top

ORM\Testing\EntityFetcherMock\Result::update

public function update(array $updates): int

Execute an update statement for the current query

NOTE: not all drivers support UPDATE with JOIN (or FROM). Has to be implemented in the database abstraction layer.

$updates should be an array which columns to update with what value. Use expressions to bypass escaping.

Parameters

ORM\Testing\EntityFetcherMock\Result::update

↑ top

ORM\Testing\EntityFetcherMock\Result::where

public function where(
    string $column, 
    mixed $operator = null, 
    mixed $value = null, 
): $this

Alias for andWhere

QueryBuilderInterface where($column[, $operator[, $value]]);

If $column has the same amount of question marks as $value - $value is the second parameter.

If there is no third parameter and no question mark in $column then the default operator is ‘=’ and $value is the second parameter.

These calls are equal:

$query->where('name', '=' , 'John Doe');
$query->where('name = ?', 'John Doe');
$query->where('name', 'John Doe');
$query->where('name = ?', ['John Doe']);

Parameters

See Also:

• ORM\QueryBuilder\ParenthesisInterface::andWhere()

ORM\Testing\EntityFetcherMock\Result::where

↑ top

ORM\Testing\EntityFetcherMock\Result::whereIn

public function whereIn(string|array $column, array $values): $this

Add a where in condition with AND.

If $column is an array a composite where in statement will be created

Example: whereIn(['a', 'b'], [[42, 23], [42, 23]]) gets (a,b) IN ((42,23), (23,42)) in mysql

If $values is empty the expression will be 1 = 0 because an empty parenthesis causes an error in SQL.

Parameters

ORM\Testing\EntityFetcherMock\Result::whereIn

↑ top

ORM\Testing\EntityFetcherMock\Result::whereNotIn

public function whereNotIn(string|array $column, array $values): $this

Add a where not in condition with AND.

If $column is an array a composite where in statement will be created

Example: whereIn(['a', 'b'], [[42, 23], [42, 23]]) gets (a,b) NOT IN ((42,23), (23,42)) in mysql

If $values is empty the expression will be 1 = 1 because an empty parenthesis causes an error in SQL.

Parameters

ORM\Testing\EntityFetcherMock\Result::whereNotIn

↑ top

ORM\Testing\EntityFetcherMock\Result::with

public function with(string $relations): $this

Load $relations after all objects are loaded

The relations are only loaded after you execute ->all()

Parameters

ORM\Testing\EntityFetcherMock\Result::with

↑ top

ORM\Testing\EntityFetcherMock\Result::withoutFilter

public function withoutFilter(string $filterClass): $this

Exclude $filterClass for this fetcher

Parameters

ORM\Testing\EntityFetcherMock\Result::withoutFilter

↑ top