Query

Class Query

This class provides methods for building and executing database queries. It is used as a trait in other classes that need query building capabilities.

• Full name: \Zemit\Mvc\Controller\Traits\Query

Properties

find

protected ?\Phalcon\Support\Collection $find

Methods

initialize

Initializes the query builder with default values for various properties.

public initialize(): mixed

Throws:

• Exception

• Exception

initializeFind

Initializes the find property with a new Collection object.

public initializeFind(): void

The values of various properties are assigned to the corresponding keys of the Collection object.

setFind

Sets the value of the find property.

public setFind(\Phalcon\Support\Collection|null $find): void

Parameters:

getFind

Retrieves the value of the find property.

public getFind(): \Phalcon\Support\Collection|null

Return Value:

The value of the find property.

prepareFind

Builds the find array for a query.

public prepareFind(\Phalcon\Support\Collection|null $find = null, bool $ignoreKey = false): array

Parameters:

Return Value:

The built find array.

find

Find records in the database using the specified criteria.

public find(array|null $find = null): \Phalcon\Mvc\Model\ResultsetInterface

Parameters:

Return Value:

The result of the find operation.

findWith

Find records in the database using the specified criteria and include related records.

public findWith(array|null $with = null, array|null $find = null): array

Parameters:

Return Value:

The result of the find operation with loaded relationships.

findFirst

Find the first record in the database using the specified criteria.

public findFirst(array|null $find = null): mixed

Parameters:

Return Value:

The result of the find operation, which is the first record that matches the criteria.

findFirstWith

Find the first record in the database using the specified criteria and relations.

public findFirstWith(array|null $with = null, array|null $find = null): mixed

Parameters:

Return Value:

The result of the find operation for the first record.

average

Calculates the average value based on a given set of criteria.

public average(array|null $find = null): float|\Phalcon\Mvc\Model\ResultsetInterface

Parameters:

Return Value:

The average value or a result set containing the average value.

count

Retrieves the total count of items based on the specified model name and find criteria.

public count(array|null $find = null): int|\Phalcon\Mvc\Model\ResultsetInterface

Note: limit and offset are removed from the parameters in order to retrieve the total count

Parameters:

Return Value:

The total count of items that match the specified criteria.

Throws:

• Exception

sum

Calculates the sum of values based on a given search criteria.

public sum(array|null $find = null): float|\Phalcon\Mvc\Model\ResultsetInterface

Parameters:

Return Value:

The calculated sum of values.

maximum

Retrieves the minimum value.

public maximum(array|null $find = null): float|\Phalcon\Mvc\Model\ResultsetInterface

Parameters:

Return Value:

The maximum value from the dataset or a ResultsetInterface that represents the grouped maximum values.

minimum

Retrieves the minimum value.

public minimum(array|null $find = null): float|\Phalcon\Mvc\Model\ResultsetInterface

Parameters:

Return Value:

The minimum value from the dataset or a ResultsetInterface that represents the grouped minimum values.

getCalculationFind

Retrieves the count criteria based on the specified find criteria.

protected getCalculationFind(array|null $find = null): array

Parameters:

Return Value:

An array of filtered find criteria without the 'limit' and 'offset' keys.

generateBindKey

Generates a unique bind key with the given prefix.

public generateBindKey(string $prefix): string

Parameters:

Return Value:

The generated bind key.