---
title: "Phalcon Datamapper"
version: "5.23"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Datamapper
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## DataMapper\Pdo\Connection
Class
Provides array quoting, profiling, a new `perform()` method, new `fetch*()`
methods
- [`Phalcon\DataMapper\Pdo\Connection\AbstractConnection`](#datamapperpdoconnectionabstractconnection)
- **`Phalcon\DataMapper\Pdo\Connection`**
`Phalcon\Contracts\DataMapper\DataMapperTypes` · `Phalcon\DataMapper\Pdo\Connection\AbstractConnection` · `Phalcon\DataMapper\Pdo\Exception\DriverNotSupported` · `Phalcon\DataMapper\Pdo\Profiler\Profiler` · `Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface`
### Method Summary
- `public __construct(string $dsn, string|null $username = null, string|null $password = null, array $options = [], array $queries = [], ProfilerInterface|null $profiler = null)` — Constructor.
- `public __debugInfo(): array` — The purpose of this method is to hide sensitive data from stack traces.
- `public connect(): void` — Connects to the database.
- `public disconnect(): void` — Disconnects from the database.
### Properties
- `protected array $arguments = []`
### Methods
__construct()
```php
public function __construct(
string $dsn,
string|null $username = null,
string|null $password = null,
array $options = [],
array $queries = [],
ProfilerInterface|null $profiler = null
);
```
Constructor.
This overrides the parent so that it can take connection attributes as a
constructor parameter, and set them after connection.
__debugInfo()
```php
public function __debugInfo(): array;
```
The purpose of this method is to hide sensitive data from stack traces.
connect()
```php
public function connect(): void;
```
Connects to the database.
disconnect()
```php
public function disconnect(): void;
```
Disconnects from the database.
## DataMapper\Pdo\ConnectionLocator
Class
Manages Connection instances for default, read, and write connections.
The locator gives its events manager to each connection that it returns,
so connections that are built on demand also fire the DataMapper events.
- **`Phalcon\DataMapper\Pdo\ConnectionLocator`** - implements [`Phalcon\DataMapper\Pdo\ConnectionLocatorInterface`](#datamapperpdoconnectionlocatorinterface), [`Phalcon\Contracts\Events\EventsAware`](/5.23/api/phalcon_contracts/#contractseventseventsaware)
`Phalcon\Contracts\DataMapper\DataMapperTypes` · `Phalcon\Contracts\Events\EventsAware` · `Phalcon\DataMapper\Pdo\Connection\ConnectionInterface` · `Phalcon\DataMapper\Pdo\Exception\ConnectionNotFound` · `Phalcon\Events\ManagerInterface` · `Phalcon\Events\Traits\EventsAwareTrait`
### Method Summary
- `public __construct(ConnectionInterface $master, array $read = [], array $write = [])` — Constructor.
- `public getMaster(): ConnectionInterface` — Returns the default connection object.
- `public getRead(string $name = ""): ConnectionInterface` — Returns a read connection by name; if no name is given, picks a
- `public getWrite(string $name = ""): ConnectionInterface` — Returns a write connection by name; if no name is given, picks a
- `public setMaster(ConnectionInterface $callableObject): static` — Sets the default connection factory.
- `public setRead(string $name, callable $callableObject): static` — Sets a read connection factory by name.
- `public setWrite(string $name, callable $callableObject): static` — Sets a write connection factory by name.
- `protected getConnection(string $type, string $name = ""): ConnectionInterface` — Returns a connection by name.
### Properties
- `protected ConnectionInterface $master` — A default Connection connection factory/instance.
- `protected array $read = []` — A registry of Connection "read" factories/instances.
- `protected array $write = []` — A registry of Connection "write" factories/instances.
### Methods
__construct()
```php
public function __construct(
ConnectionInterface $master,
array $read = [],
array $write = []
);
```
Constructor.
getMaster()
```php
public function getMaster(): ConnectionInterface;
```
Returns the default connection object.
getRead()
```php
public function getRead( string $name = "" ): ConnectionInterface;
```
Returns a read connection by name; if no name is given, picks a
random connection; if no read connections are present, returns the
default connection.
getWrite()
```php
public function getWrite( string $name = "" ): ConnectionInterface;
```
Returns a write connection by name; if no name is given, picks a
random connection; if no write connections are present, returns the
default connection.
setMaster()
```php
public function setMaster( ConnectionInterface $callableObject ): static;
```
Sets the default connection factory.
setRead()
```php
public function setRead(
string $name,
callable $callableObject
): static;
```
Sets a read connection factory by name.
setWrite()
```php
public function setWrite(
string $name,
callable $callableObject
): static;
```
Sets a write connection factory by name.
getConnection()
```php
protected function getConnection(
string $type,
string $name = ""
): ConnectionInterface;
```
Returns a connection by name.
## DataMapper\Pdo\ConnectionLocatorInterface
Interface
Locates PDO connections for default, read, and write databases.
- **`Phalcon\DataMapper\Pdo\ConnectionLocatorInterface`**
`Phalcon\Contracts\DataMapper\DataMapperTypes` · `Phalcon\DataMapper\Pdo\Connection\ConnectionInterface`
### Method Summary
- `public getMaster(): ConnectionInterface` — Returns the default connection object.
- `public getRead(string $name = ""): ConnectionInterface` — Returns a read connection by name; if no name is given, picks a
- `public getWrite(string $name = ""): ConnectionInterface` — Returns a write connection by name; if no name is given, picks a
- `public setMaster(ConnectionInterface $callableObject): ConnectionLocatorInterface` — Sets the default connection registry entry.
- `public setRead(string $name, callable $callableObject): ConnectionLocatorInterface` — Sets a read connection registry entry by name.
- `public setWrite(string $name, callable $callableObject): ConnectionLocatorInterface` — Sets a write connection registry entry by name.
### Methods
getMaster()
```php
public function getMaster(): ConnectionInterface;
```
Returns the default connection object.
getRead()
```php
public function getRead( string $name = "" ): ConnectionInterface;
```
Returns a read connection by name; if no name is given, picks a
random connection; if no read connections are present, returns the
default connection.
getWrite()
```php
public function getWrite( string $name = "" ): ConnectionInterface;
```
Returns a write connection by name; if no name is given, picks a
random connection; if no write connections are present, returns the
default connection.
setMaster()
```php
public function setMaster( ConnectionInterface $callableObject ): ConnectionLocatorInterface;
```
Sets the default connection registry entry.
setRead()
```php
public function setRead(
string $name,
callable $callableObject
): ConnectionLocatorInterface;
```
Sets a read connection registry entry by name.
setWrite()
```php
public function setWrite(
string $name,
callable $callableObject
): ConnectionLocatorInterface;
```
Sets a write connection registry entry by name.
## DataMapper\Pdo\Connection\AbstractConnection
Abstract
Provides array quoting, profiling, a new `perform()` method, new `fetch*()`
methods
Connections fire the lifecycle events in Phalcon\DataMapper\Pdo\Events when
an events manager is set. ConnectionInterface does not declare the events
manager methods; the EventsAware contract is applied here so that existing
implementations of the interface keep working.
- **`Phalcon\DataMapper\Pdo\Connection\AbstractConnection`** - implements [`Phalcon\DataMapper\Pdo\Connection\ConnectionInterface`](#datamapperpdoconnectionconnectioninterface), [`Phalcon\Contracts\Events\EventsAware`](/5.23/api/phalcon_contracts/#contractseventseventsaware)
- [`Phalcon\DataMapper\Pdo\Connection`](#datamapperpdoconnection)
- [`Phalcon\DataMapper\Pdo\Connection\Decorated`](#datamapperpdoconnectiondecorated)
`BadMethodCallException` · `PDO` · `PDOException` · `PDOStatement` · `Phalcon\Contracts\DataMapper\DataMapperTypes` · `Phalcon\Contracts\Events\EventsAware` · `Phalcon\DataMapper\Pdo\Events` · `Phalcon\DataMapper\Pdo\Exception\OperationCancelled` · `Phalcon\DataMapper\Pdo\Exception\UnknownDriverMethod` · `Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface` · `Phalcon\Events\ManagerInterface` · `Phalcon\Events\Traits\EventsAwareTrait` · `Throwable` · `stdClass`
### Method Summary
- `public __call(mixed $name, array $arguments)` — Proxies to PDO methods created for specific drivers; in particular,
- `public beginTransaction(): bool` — Begins a transaction. If the profiler is enabled, the operation will
- `public commit(): bool` — Commits the existing transaction. If the profiler is enabled, the
- `public connect(): void` — Connects to the database.
- `public disconnect(): void` — Disconnects from the database.
- `public ensureConnection(): void` — Ensures the connection is alive, reconnecting in place if it is not.
- `public errorCode(): string|null` — Gets the most recent error code.
- `public errorInfo(): array` — Gets the most recent error info.
- `public exec(string $statement): int` — Executes an SQL statement and returns the number of affected rows. If
- `public fetchAffected(string $statement, array $values = []): int` — Performs a statement and returns the number of affected rows.
- `public fetchAll(string $statement, array $values = []): array` — Fetches a sequential array of rows from the database; the rows are
- `public fetchAssoc(string $statement, array $values = []): array` — Fetches an associative array of rows from the database; the rows are
- `public fetchColumn(string $statement, array $values = [], int $column = 0): array` — Fetches a column of rows as a sequential array (default first one).
- `public fetchGroup(string $statement, array $values = [], int $flags = \PDO::FETCH_ASSOC): array` — Fetches multiple from the database as an associative array. The first
- `public fetchObject(string $statement, array $values = [], string $className = "stdClass", array $arguments = []): object` — Fetches one row from the database as an object where the column values
- `public fetchObjects(string $statement, array $values = [], string $className = "stdClass", array $arguments = []): array` — Fetches a sequential array of rows from the database; the rows are
- `public fetchOne(string $statement, array $values = []): array` — Fetches one row from the database as an associative array.
- `public fetchPairs(string $statement, array $values = []): array` — Fetches an associative array of rows as key-value pairs (first column is
- `public fetchValue(string $statement, array $values = [])` — Fetches the very first value (i.e., first column of the first row).
- `public getAdapter(): \PDO` — Return the inner PDO (if any)
- `public getAttribute(int $attribute): mixed` — Retrieve a database connection attribute
- `public getAutoReconnect(): bool` — Returns whether transparent auto-reconnect is enabled.
- `public getAvailableDrivers(): array` — Return an array of available PDO drivers (empty array if none available)
- `public getDriverName(): string` — Return the driver name
- `public getProfiler(): ProfilerInterface` — Returns the Profiler instance.
- `public getQuoteNames(string $driver = ""): array` — Gets the quote parameters based on the driver
- `public inTransaction(): bool` — Is a transaction currently active? If the profiler is enabled, the
- `public isConnected(): bool` — Is the PDO connection active?
- `public lastInsertId(string|null $name = null): string` — Returns the last inserted autoincrement sequence value. If the profiler
- `public perform(string $statement, array $values = []): \PDOStatement` — Performs a query with bound values and returns the resulting
- `public ping(): bool` — Checks whether the underlying connection is still alive by issuing a
- `public prepare(string $statement, array $options = []): \PDOStatement|bool` — Prepares an SQL statement for execution.
- `public query(string $statement): \PDOStatement|bool` — Queries the database and returns a PDOStatement. If the profiler is
- `public quote(mixed $value, int $type = \PDO::PARAM_STR): string` — Quotes a value for use in an SQL statement. This differs from
- `public rollBack(): bool` — Rolls back the current transaction, and restores autocommit mode. If the
- `public setAttribute(int $attribute, mixed $value): bool` — Set a database connection attribute
- `public setAutoReconnect(bool $autoReconnect): static` — Enables or disables transparent auto-reconnect on a lost connection.
- `public setProfiler(ProfilerInterface $profiler): static` — Sets the Profiler instance.
- `protected fetchData(string $method, array $arguments, string $statement, array $values = []): array` — Helper method to get data from PDO based on the method passed
- `protected fireBefore(string $eventName, mixed $data = null): void` — Fires a cancelable "before" event. A listener cancels by stopping the
- `protected isConnectionError(\Throwable $exception): bool` — Recognizes a lost ("gone away") connection. Detection is driver-agnostic:
- `protected performBind(\PDOStatement $statement, mixed $name, mixed $arguments): void` — Bind a value using the proper PDO::PARAM\_\* type.
### Properties
- `protected bool $autoReconnect = false` — Whether to transparently reconnect and retry once when a statement fails
because the connection was lost. Opt-in; off by default.
- `protected \PDO|null $pdo`
- `protected ProfilerInterface $profiler`
- `protected int $transactionLevel = 0` — Current transaction nesting level. Tracked locally rather than via
PDO::inTransaction() because some drivers report a broken connection as
being "in transaction".
### Methods
__call()
```php
public function __call(
mixed $name,
array $arguments
);
```
Proxies to PDO methods created for specific drivers; in particular,
`sqlite` and `pgsql`.
beginTransaction()
```php
public function beginTransaction(): bool;
```
Begins a transaction. If the profiler is enabled, the operation will
be recorded.
commit()
```php
public function commit(): bool;
```
Commits the existing transaction. If the profiler is enabled, the
operation will be recorded.
connect()
```php
abstract public function connect(): void;
```
Connects to the database.
disconnect()
```php
abstract public function disconnect(): void;
```
Disconnects from the database.
ensureConnection()
```php
public function ensureConnection(): void;
```
Ensures the connection is alive, reconnecting in place if it is not.
disconnect() is required first because connect() is idempotent and will
not rebuild a dead-but-present handle.
errorCode()
```php
public function errorCode(): string|null;
```
Gets the most recent error code.
errorInfo()
```php
public function errorInfo(): array;
```
Gets the most recent error info.
exec()
```php
public function exec( string $statement ): int;
```
Executes an SQL statement and returns the number of affected rows. If
the profiler is enabled, the operation will be recorded.
fetchAffected()
```php
public function fetchAffected(
string $statement,
array $values = []
): int;
```
Performs a statement and returns the number of affected rows.
fetchAll()
```php
public function fetchAll(
string $statement,
array $values = []
): array;
```
Fetches a sequential array of rows from the database; the rows are
returned as associative arrays.
fetchAssoc()
```php
public function fetchAssoc(
string $statement,
array $values = []
): array;
```
Fetches an associative array of rows from the database; the rows are
returned as associative arrays, and the array of rows is keyed on the
first column of each row.
If multiple rows have the same first column value, the last row with
that value will overwrite earlier rows. This method is more resource
intensive and should be avoided if possible.
fetchColumn()
```php
public function fetchColumn(
string $statement,
array $values = [],
int $column = 0
): array;
```
Fetches a column of rows as a sequential array (default first one).
fetchGroup()
```php
public function fetchGroup(
string $statement,
array $values = [],
int $flags = \PDO::FETCH_ASSOC
): array;
```
Fetches multiple from the database as an associative array. The first
column will be the index key. The default flags are
PDO::FETCH_ASSOC | PDO::FETCH_GROUP
fetchObject()
```php
public function fetchObject(
string $statement,
array $values = [],
string $className = "stdClass",
array $arguments = []
): object;
```
Fetches one row from the database as an object where the column values
are mapped to object properties.
Since PDO injects property values before invoking the constructor, any
initializations for defaults that you potentially have in your object's
constructor, will override the values that have been injected by
`fetchObject`. The default object returned is `\stdClass`
PDOStatement::fetchObject() returns false when there is no row. The
interface declares `object`, so an empty `stdClass` is returned
instead. The `object|false` return type lands in v7.
fetchObjects()
```php
public function fetchObjects(
string $statement,
array $values = [],
string $className = "stdClass",
array $arguments = []
): array;
```
Fetches a sequential array of rows from the database; the rows are
returned as objects where the column values are mapped to object
properties.
Since PDO injects property values before invoking the constructor, any
initializations for defaults that you potentially have in your object's
constructor, will override the values that have been injected by
`fetchObject`. The default object returned is `\stdClass`
fetchOne()
```php
public function fetchOne(
string $statement,
array $values = []
): array;
```
Fetches one row from the database as an associative array.
fetchPairs()
```php
public function fetchPairs(
string $statement,
array $values = []
): array;
```
Fetches an associative array of rows as key-value pairs (first column is
the key, second column is the value).
fetchValue()
```php
public function fetchValue(
string $statement,
array $values = []
);
```
Fetches the very first value (i.e., first column of the first row).
getAdapter()
```php
public function getAdapter(): \PDO;
```
Return the inner PDO (if any)
getAttribute()
```php
public function getAttribute( int $attribute ): mixed;
```
Retrieve a database connection attribute
getAutoReconnect()
```php
public function getAutoReconnect(): bool;
```
Returns whether transparent auto-reconnect is enabled.
getAvailableDrivers()
```php
public static function getAvailableDrivers(): array;
```
Return an array of available PDO drivers (empty array if none available)
getDriverName()
```php
public function getDriverName(): string;
```
Return the driver name
getProfiler()
```php
public function getProfiler(): ProfilerInterface;
```
Returns the Profiler instance.
getQuoteNames()
```php
public function getQuoteNames( string $driver = "" ): array;
```
Gets the quote parameters based on the driver
inTransaction()
```php
public function inTransaction(): bool;
```
Is a transaction currently active? If the profiler is enabled, the
operation will be recorded. If the profiler is enabled, the operation
will be recorded.
isConnected()
```php
public function isConnected(): bool;
```
Is the PDO connection active?
lastInsertId()
```php
public function lastInsertId( string|null $name = null ): string;
```
Returns the last inserted autoincrement sequence value. If the profiler
is enabled, the operation will be recorded.
```php
public function perform(
string $statement,
array $values = []
): \PDOStatement;
```
Performs a query with bound values and returns the resulting
PDOStatement; array values will be passed through `quote()` and their
respective placeholders will be replaced in the query string. If the
profiler is enabled, the operation will be recorded.
ping()
```php
public function ping(): bool;
```
Checks whether the underlying connection is still alive by issuing a
trivial query. Returns false if there is no handle or the probe fails.
prepare()
```php
public function prepare(
string $statement,
array $options = []
): \PDOStatement|bool;
```
Prepares an SQL statement for execution.
query()
```php
public function query( string $statement ): \PDOStatement|bool;
```
Queries the database and returns a PDOStatement. If the profiler is
enabled, the operation will be recorded.
quote()
```php
public function quote(
mixed $value,
int $type = \PDO::PARAM_STR
): string;
```
Quotes a value for use in an SQL statement. This differs from
`PDO::quote()` in that it will convert an array into a string of
comma-separated quoted values. The default type is `PDO::PARAM_STR`
rollBack()
```php
public function rollBack(): bool;
```
Rolls back the current transaction, and restores autocommit mode. If the
profiler is enabled, the operation will be recorded.
setAttribute()
```php
public function setAttribute(
int $attribute,
mixed $value
): bool;
```
Set a database connection attribute
setAutoReconnect()
```php
public function setAutoReconnect( bool $autoReconnect ): static;
```
Enables or disables transparent auto-reconnect on a lost connection.
setProfiler()
```php
public function setProfiler( ProfilerInterface $profiler ): static;
```
Sets the Profiler instance.
fetchData()
```php
protected function fetchData(
string $method,
array $arguments,
string $statement,
array $values = []
): array;
```
Helper method to get data from PDO based on the method passed
fireBefore()
```php
protected function fireBefore(
string $eventName,
mixed $data = null
): void;
```
Fires a cancelable "before" event. A listener cancels by stopping the
event and returning false; see Phalcon\DataMapper\Pdo\Events for the
required idiom. The operation does not run when it is canceled.
isConnectionError()
```php
protected function isConnectionError( \Throwable $exception ): bool;
```
Recognizes a lost ("gone away") connection. Detection is driver-agnostic:
the driver name is not queried because the underlying connection may be
dead by this point. The MySQL error codes and PostgreSQL SQLSTATEs do not
overlap, so all known signatures are checked unconditionally.
```php
protected function performBind(
\PDOStatement $statement,
mixed $name,
mixed $arguments
): void;
```
Bind a value using the proper PDO::PARAM_* type.
## DataMapper\Pdo\Connection\ConnectionInterface
Interface
Provides array quoting, profiling, a new `perform()` method, new `fetch*()`
methods
- [`Phalcon\DataMapper\Pdo\Connection\PdoInterface`](#datamapperpdoconnectionpdointerface)
- **`Phalcon\DataMapper\Pdo\Connection\ConnectionInterface`**
`Phalcon\Contracts\DataMapper\DataMapperTypes` · `Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface`
### Method Summary
- `public connect(): void` — Connects to the database.
- `public disconnect(): void` — Disconnects from the database.
- `public fetchAffected(string $statement, array $values = []): int` — Performs a statement and returns the number of affected rows.
- `public fetchAll(string $statement, array $values = []): array` — Fetches a sequential array of rows from the database; the rows are
- `public fetchAssoc(string $statement, array $values = []): array` — Fetches an associative array of rows from the database; the rows are
- `public fetchColumn(string $statement, array $values = [], int $column = 0): array` — Fetches a column of rows as a sequential array (default first one).
- `public fetchGroup(string $statement, array $values = [], int $flags = \PDO::FETCH_ASSOC): array` — Fetches multiple from the database as an associative array. The first
- `public fetchObject(string $statement, array $values = [], string $className = "stdClass", array $arguments = []): object` — Fetches one row from the database as an object where the column values
- `public fetchObjects(string $statement, array $values = [], string $className = "stdClass", array $arguments = []): array` — Fetches a sequential array of rows from the database; the rows are
- `public fetchOne(string $statement, array $values = []): array` — Fetches one row from the database as an associative array.
- `public fetchPairs(string $statement, array $values = []): array` — Fetches an associative array of rows as key-value pairs (first column is
- `public fetchValue(string $statement, array $values = []): mixed` — Fetches the very first value (i.e., first column of the first row).
- `public getAdapter(): \PDO` — Return the inner PDO (if any)
- `public getProfiler(): ProfilerInterface` — Returns the Profiler instance.
- `public isConnected(): bool` — Is the PDO connection active?
- `public perform(string $statement, array $values = []): \PDOStatement` — Performs a query with bound values and returns the resulting
- `public setProfiler(ProfilerInterface $profiler)` — Sets the Profiler instance.
### Methods
connect()
```php
public function connect(): void;
```
Connects to the database.
disconnect()
```php
public function disconnect(): void;
```
Disconnects from the database.
fetchAffected()
```php
public function fetchAffected(
string $statement,
array $values = []
): int;
```
Performs a statement and returns the number of affected rows.
fetchAll()
```php
public function fetchAll(
string $statement,
array $values = []
): array;
```
Fetches a sequential array of rows from the database; the rows are
returned as associative arrays.
fetchAssoc()
```php
public function fetchAssoc(
string $statement,
array $values = []
): array;
```
Fetches an associative array of rows from the database; the rows are
returned as associative arrays, and the array of rows is keyed on the
first column of each row.
If multiple rows have the same first column value, the last row with
that value will overwrite earlier rows. This method is more resource
intensive and should be avoided if possible.
fetchColumn()
```php
public function fetchColumn(
string $statement,
array $values = [],
int $column = 0
): array;
```
Fetches a column of rows as a sequential array (default first one).
fetchGroup()
```php
public function fetchGroup(
string $statement,
array $values = [],
int $flags = \PDO::FETCH_ASSOC
): array;
```
Fetches multiple from the database as an associative array. The first
column will be the index key. The default flags are
PDO::FETCH_ASSOC | PDO::FETCH_GROUP
fetchObject()
```php
public function fetchObject(
string $statement,
array $values = [],
string $className = "stdClass",
array $arguments = []
): object;
```
Fetches one row from the database as an object where the column values
are mapped to object properties.
Since PDO injects property values before invoking the constructor, any
initializations for defaults that you potentially have in your object's
constructor, will override the values that have been injected by
`fetchObject`. The default object returned is `\stdClass`
An empty `stdClass` is returned when there is no row. The
`object|false` return type lands in v7.
fetchObjects()
```php
public function fetchObjects(
string $statement,
array $values = [],
string $className = "stdClass",
array $arguments = []
): array;
```
Fetches a sequential array of rows from the database; the rows are
returned as objects where the column values are mapped to object
properties.
Since PDO injects property values before invoking the constructor, any
initializations for defaults that you potentially have in your object's
constructor, will override the values that have been injected by
`fetchObject`. The default object returned is `\stdClass`
fetchOne()
```php
public function fetchOne(
string $statement,
array $values = []
): array;
```
Fetches one row from the database as an associative array.
fetchPairs()
```php
public function fetchPairs(
string $statement,
array $values = []
): array;
```
Fetches an associative array of rows as key-value pairs (first column is
the key, second column is the value).
fetchValue()
```php
public function fetchValue(
string $statement,
array $values = []
): mixed;
```
Fetches the very first value (i.e., first column of the first row).
getAdapter()
```php
public function getAdapter(): \PDO;
```
Return the inner PDO (if any)
getProfiler()
```php
public function getProfiler(): ProfilerInterface;
```
Returns the Profiler instance.
isConnected()
```php
public function isConnected(): bool;
```
Is the PDO connection active?
```php
public function perform(
string $statement,
array $values = []
): \PDOStatement;
```
Performs a query with bound values and returns the resulting
PDOStatement; array values will be passed through `quote()` and their
respective placeholders will be replaced in the query string. If the
profiler is enabled, the operation will be recorded.
setProfiler()
```php
public function setProfiler( ProfilerInterface $profiler );
```
Sets the Profiler instance.
## DataMapper\Pdo\Connection\Decorated
Class
Decorates an existing PDO instance with the extended methods.
- [`Phalcon\DataMapper\Pdo\Connection\AbstractConnection`](#datamapperpdoconnectionabstractconnection)
- **`Phalcon\DataMapper\Pdo\Connection\Decorated`**
`Phalcon\DataMapper\Pdo\Exception\CannotDisconnect` · `Phalcon\DataMapper\Pdo\Profiler\Profiler` · `Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface`
### Method Summary
- `public __construct(\PDO $pdo, ProfilerInterface|null $profiler = null)` — Constructor.
- `public connect(): void` — Connects to the database.
- `public disconnect(): void` — Disconnects from the database; disallowed with decorated PDO connections.
### Methods
__construct()
```php
public function __construct(
\PDO $pdo,
ProfilerInterface|null $profiler = null
);
```
Constructor.
This overrides the parent so that it can take an existing PDO instance
and decorate it with the extended methods.
connect()
```php
public function connect(): void;
```
Connects to the database.
disconnect()
```php
public function disconnect(): void;
```
Disconnects from the database; disallowed with decorated PDO connections.
## DataMapper\Pdo\Connection\PdoInterface
Interface
An interface to the native PDO object.
- **`Phalcon\DataMapper\Pdo\Connection\PdoInterface`**
- [`Phalcon\DataMapper\Pdo\Connection\ConnectionInterface`](#datamapperpdoconnectionconnectioninterface)
`Phalcon\Contracts\DataMapper\DataMapperTypes`
### Method Summary
- `public beginTransaction(): bool` — Begins a transaction. If the profiler is enabled, the operation will
- `public commit(): bool` — Commits the existing transaction. If the profiler is enabled, the
- `public errorCode(): string|null` — Gets the most recent error code.
- `public errorInfo(): array` — Gets the most recent error info.
- `public exec(string $statement): int` — Executes an SQL statement and returns the number of affected rows. If
- `public getAttribute(int $attribute): mixed` — Retrieve a database connection attribute
- `public getAvailableDrivers(): array` — Return an array of available PDO drivers (empty array if none available)
- `public inTransaction(): bool` — Is a transaction currently active? If the profiler is enabled, the
- `public lastInsertId(string|null $name = null): string` — Returns the last inserted autoincrement sequence value. If the profiler
- `public prepare(string $statement, array $options = []): bool|\PDOStatement` — Prepares an SQL statement for execution.
- `public query(string $statement): bool|\PDOStatement` — Queries the database and returns a PDOStatement. If the profiler is
- `public quote(mixed $value, int $type = \PDO::PARAM_STR): string` — Quotes a value for use in an SQL statement. This differs from
- `public rollBack(): bool` — Rolls back the current transaction, and restores autocommit mode. If the
- `public setAttribute(int $attribute, mixed $value): bool` — Set a database connection attribute
### Methods
beginTransaction()
```php
public function beginTransaction(): bool;
```
Begins a transaction. If the profiler is enabled, the operation will
be recorded.
commit()
```php
public function commit(): bool;
```
Commits the existing transaction. If the profiler is enabled, the
operation will be recorded.
errorCode()
```php
public function errorCode(): string|null;
```
Gets the most recent error code.
errorInfo()
```php
public function errorInfo(): array;
```
Gets the most recent error info.
exec()
```php
public function exec( string $statement ): int;
```
Executes an SQL statement and returns the number of affected rows. If
the profiler is enabled, the operation will be recorded.
getAttribute()
```php
public function getAttribute( int $attribute ): mixed;
```
Retrieve a database connection attribute
getAvailableDrivers()
```php
public static function getAvailableDrivers(): array;
```
Return an array of available PDO drivers (empty array if none available)
inTransaction()
```php
public function inTransaction(): bool;
```
Is a transaction currently active? If the profiler is enabled, the
operation will be recorded. If the profiler is enabled, the operation
will be recorded.
lastInsertId()
```php
public function lastInsertId( string|null $name = null ): string;
```
Returns the last inserted autoincrement sequence value. If the profiler
is enabled, the operation will be recorded.
prepare()
```php
public function prepare(
string $statement,
array $options = []
): bool|\PDOStatement;
```
Prepares an SQL statement for execution.
query()
```php
public function query( string $statement ): bool|\PDOStatement;
```
Queries the database and returns a PDOStatement. If the profiler is
enabled, the operation will be recorded.
quote()
```php
public function quote(
mixed $value,
int $type = \PDO::PARAM_STR
): string;
```
Quotes a value for use in an SQL statement. This differs from
`PDO::quote()` in that it will convert an array into a string of
comma-separated quoted values. The default type is `PDO::PARAM_STR`
rollBack()
```php
public function rollBack(): bool;
```
Rolls back the current transaction, and restores autocommit mode. If the
profiler is enabled, the operation will be recorded.
setAttribute()
```php
public function setAttribute(
int $attribute,
mixed $value
): bool;
```
Set a database connection attribute
## DataMapper\Pdo\Events
Class
Lifecycle event names fired by the DataMapper connections through
Phalcon\Events\Manager. One public constant per event.
The `before*` events are cancelable. To cancel an operation, a listener
must stop the event and return false:
$manager->attach(
Events::BEFORE\_PERFORM,
function ($event) \{
$event->stop();
return false;
}
);
Both parts are necessary. `stop()` alone abandons the queue but returns
the listener's own value, which the connection cannot tell apart from
"no listeners". `return false` alone is replaced by any later non-null
return while the manager's stopOnFalse mode is off, which is the default.
A canceled operation throws
Phalcon\DataMapper\Pdo\Exception\OperationCancelled.
The `after*` events are not cancelable. The operation is complete when
they fire.
There are two groups of events. The operation events - perform, exec,
query and the three transaction events - belong to one operation each.
`prepare()` has no operation events because `perform()` calls it, and
nested events for one logical operation give listeners two counts of the
same work. The connection events - connect, disconnect and connectionLost
- report a change of the connection state. They fire each time the state
changes, whichever method causes it. An automatic reconnect from any
method therefore reports the lost connection and the new one.
- **`Phalcon\DataMapper\Pdo\Events`**
### Constants
- `const string AFTER_BEGIN_TRANSACTION = "dm:afterBeginTransaction"`
- `const string AFTER_COMMIT = "dm:afterCommit"`
- `const string AFTER_CONNECT = "dm:afterConnect"`
- `const string AFTER_DISCONNECT = "dm:afterDisconnect"`
- `const string AFTER_EXEC = "dm:afterExec"`
- `const string AFTER_PERFORM = "dm:afterPerform"`
- `const string AFTER_QUERY = "dm:afterQuery"`
- `const string AFTER_ROLLBACK = "dm:afterRollBack"`
- `const string BEFORE_BEGIN_TRANSACTION = "dm:beforeBeginTransaction"`
- `const string BEFORE_COMMIT = "dm:beforeCommit"`
- `const string BEFORE_CONNECT = "dm:beforeConnect"`
- `const string BEFORE_DISCONNECT = "dm:beforeDisconnect"`
- `const string BEFORE_EXEC = "dm:beforeExec"`
- `const string BEFORE_PERFORM = "dm:beforePerform"`
- `const string BEFORE_QUERY = "dm:beforeQuery"`
- `const string BEFORE_ROLLBACK = "dm:beforeRollBack"`
- `const string CONNECTION_LOST = "dm:connectionLost"`
## DataMapper\Pdo\Exception\CannotDisconnect
Class
ExtendedPdo could not disconnect; e.g., because its PDO connection was
created externally and then injected.
- `\Exception`
- [`Phalcon\DataMapper\Pdo\Exception\Exception`](#datamapperpdoexceptionexception)
- **`Phalcon\DataMapper\Pdo\Exception\CannotDisconnect`**
## DataMapper\Pdo\Exception\ConnectionNotFound
Class
Locator could not find a named connection.
- `\Exception`
- [`Phalcon\DataMapper\Pdo\Exception\Exception`](#datamapperpdoexceptionexception)
- **`Phalcon\DataMapper\Pdo\Exception\ConnectionNotFound`**
## DataMapper\Pdo\Exception\DriverNotSupported
Class
- `\InvalidArgumentException`
- **`Phalcon\DataMapper\Pdo\Exception\DriverNotSupported`**
`InvalidArgumentException`
### Method Summary
- `public __construct(string $driver)`
### Methods
__construct()
```php
public function __construct( string $driver );
```
## DataMapper\Pdo\Exception\Exception
Class
Base Exception class
- `\Exception`
- **`Phalcon\DataMapper\Pdo\Exception\Exception`**
- [`Phalcon\DataMapper\Pdo\Exception\CannotDisconnect`](#datamapperpdoexceptioncannotdisconnect)
- [`Phalcon\DataMapper\Pdo\Exception\ConnectionNotFound`](#datamapperpdoexceptionconnectionnotfound)
- [`Phalcon\DataMapper\Pdo\Exception\OperationCancelled`](#datamapperpdoexceptionoperationcancelled)
## DataMapper\Pdo\Exception\OperationCancelled
Class
A listener canceled a cancelable "before" event, so the operation did
not run. This is a deliberate cancellation, not a database failure. Catch
this class to tell the two apart.
- `\Exception`
- [`Phalcon\DataMapper\Pdo\Exception\Exception`](#datamapperpdoexceptionexception)
- **`Phalcon\DataMapper\Pdo\Exception\OperationCancelled`**
### Method Summary
- `public __construct(string $eventName)`
### Methods
__construct()
```php
public function __construct( string $eventName );
```
## DataMapper\Pdo\Exception\UnknownDriverMethod
Class
- `\BadMethodCallException`
- **`Phalcon\DataMapper\Pdo\Exception\UnknownDriverMethod`**
`BadMethodCallException`
### Method Summary
- `public __construct(string $message)`
### Methods
__construct()
```php
public function __construct( string $message );
```
## DataMapper\Pdo\Exception\UnknownQueryMethod
Class
- `\BadMethodCallException`
- **`Phalcon\DataMapper\Pdo\Exception\UnknownQueryMethod`**
`BadMethodCallException`
### Method Summary
- `public __construct(string $method)`
### Methods
__construct()
```php
public function __construct( string $method );
```
## DataMapper\Pdo\Profiler\MemoryLogger
Class
A memory-based logger.
- **`Phalcon\DataMapper\Pdo\Profiler\MemoryLogger`** - implements [`Phalcon\Logger\LoggerInterface`](/5.23/api/phalcon_logger/#loggerloggerinterface)
`Phalcon\Contracts\DataMapper\DataMapperTypes` · `Phalcon\Logger\Adapter\AdapterInterface` · `Phalcon\Logger\Adapter\Noop` · `Phalcon\Logger\Enum` · `Phalcon\Logger\LoggerInterface`
### Method Summary
- `public alert(string $message, array $context = []): void`
- `public critical(string $message, array $context = []): void`
- `public debug(string $message, array $context = []): void`
- `public emergency(string $message, array $context = []): void`
- `public error(string $message, array $context = []): void`
- `public getAdapter(string $name): AdapterInterface` — Returns an adapter from the stack
- `public getAdapters(): array` — Returns the adapter stack array
- `public getLogLevel(): int` — Returns the log level
- `public getMessages(): array` — Returns the logged messages.
- `public getName(): string` — Returns the name of the logger
- `public info(string $message, array $context = []): void`
- `public log(mixed $level, string $message, array $context = []): void` — Logs a message.
- `public notice(string $message, array $context = []): void`
- `public trace(string $message, array $context = []): void`
- `public warning(string $message, array $context = []): void`
### Properties
- `protected array $messages = []`
### Methods
alert()
```php
public function alert(
string $message,
array $context = []
): void;
```
critical()
```php
public function critical(
string $message,
array $context = []
): void;
```
debug()
```php
public function debug(
string $message,
array $context = []
): void;
```
emergency()
```php
public function emergency(
string $message,
array $context = []
): void;
```
error()
```php
public function error(
string $message,
array $context = []
): void;
```
getAdapter()
```php
public function getAdapter( string $name ): AdapterInterface;
```
Returns an adapter from the stack
getAdapters()
```php
public function getAdapters(): array;
```
Returns the adapter stack array
getLogLevel()
```php
public function getLogLevel(): int;
```
Returns the log level
getMessages()
```php
public function getMessages(): array;
```
Returns the logged messages.
getName()
```php
public function getName(): string;
```
Returns the name of the logger
info()
```php
public function info(
string $message,
array $context = []
): void;
```
log()
```php
public function log(
mixed $level,
string $message,
array $context = []
): void;
```
Logs a message.
notice()
```php
public function notice(
string $message,
array $context = []
): void;
```
trace()
```php
public function trace(
string $message,
array $context = []
): void;
```
warning()
```php
public function warning(
string $message,
array $context = []
): void;
```
## DataMapper\Pdo\Profiler\Profiler
Class
Sends query profiles to a logger.
- **`Phalcon\DataMapper\Pdo\Profiler\Profiler`** - implements [`Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface`](#datamapperpdoprofilerprofilerinterface)
`Phalcon\Contracts\DataMapper\DataMapperTypes` · `Phalcon\DataMapper\Pdo\Exception\Exception` · `Phalcon\Logger\Enum` · `Phalcon\Logger\LoggerInterface` · `Phalcon\Support\Helper\Json\Encode`
### Method Summary
- `public __construct(LoggerInterface|null $logger = null)` — Constructor.
- `public finish(string|null $statement = null, array $values = []): void` — Finishes and logs a profile entry.
- `public getLogFormat(): string` — Returns the log message format string, with placeholders.
- `public getLogLevel(): string` — Returns the level at which to log profile messages.
- `public getLogger(): LoggerInterface` — Returns the underlying logger instance.
- `public isActive(): bool` — Returns true if logging is active.
- `public setActive(bool $active): ProfilerInterface` — Enable or disable profiler logging.
- `public setLogFormat(string $logFormat): ProfilerInterface` — Sets the log message format string, with placeholders.
- `public setLogLevel(string $logLevel): ProfilerInterface` — Level at which to log profile messages.
- `public start(string $method): void` — Starts a profile entry.
### Properties
- `protected bool $active = false`
- `protected array $context = []`
- `protected string $logFormat = ""`
- `protected int|string $logLevel = 0`
- `protected LoggerInterface $logger`
### Methods
__construct()
```php
public function __construct( LoggerInterface|null $logger = null );
```
Constructor.
finish()
```php
public function finish(
string|null $statement = null,
array $values = []
): void;
```
Finishes and logs a profile entry.
```php
public function getLogFormat(): string;
```
Returns the log message format string, with placeholders.
getLogLevel()
```php
public function getLogLevel(): string;
```
Returns the level at which to log profile messages.
getLogger()
```php
public function getLogger(): LoggerInterface;
```
Returns the underlying logger instance.
isActive()
```php
public function isActive(): bool;
```
Returns true if logging is active.
setActive()
```php
public function setActive( bool $active ): ProfilerInterface;
```
Enable or disable profiler logging.
```php
public function setLogFormat( string $logFormat ): ProfilerInterface;
```
Sets the log message format string, with placeholders.
setLogLevel()
```php
public function setLogLevel( string $logLevel ): ProfilerInterface;
```
Level at which to log profile messages.
start()
```php
public function start( string $method ): void;
```
Starts a profile entry.
## DataMapper\Pdo\Profiler\ProfilerInterface
Interface
Interface to send query profiles to a logger.
- **`Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface`**
`Phalcon\Contracts\DataMapper\DataMapperTypes` · `Phalcon\Logger\LoggerInterface`
### Method Summary
- `public finish(string|null $statement = null, array $values = []): void` — Finishes and logs a profile entry.
- `public getLogFormat(): string` — Returns the log message format string, with placeholders.
- `public getLogLevel(): string` — Returns the level at which to log profile messages.
- `public getLogger(): LoggerInterface` — Returns the underlying logger instance.
- `public isActive(): bool` — Returns true if logging is active.
- `public setActive(bool $active): ProfilerInterface` — Enable or disable profiler logging.
- `public setLogFormat(string $logFormat): ProfilerInterface` — Sets the log message format string, with placeholders.
- `public setLogLevel(string $logLevel): ProfilerInterface` — Level at which to log profile messages.
- `public start(string $method): void` — Starts a profile entry.
### Methods
finish()
```php
public function finish(
string|null $statement = null,
array $values = []
): void;
```
Finishes and logs a profile entry.
```php
public function getLogFormat(): string;
```
Returns the log message format string, with placeholders.
getLogLevel()
```php
public function getLogLevel(): string;
```
Returns the level at which to log profile messages.
getLogger()
```php
public function getLogger(): LoggerInterface;
```
Returns the underlying logger instance.
isActive()
```php
public function isActive(): bool;
```
Returns true if logging is active.
setActive()
```php
public function setActive( bool $active ): ProfilerInterface;
```
Enable or disable profiler logging.
```php
public function setLogFormat( string $logFormat ): ProfilerInterface;
```
Sets the log message format string, with placeholders.
setLogLevel()
```php
public function setLogLevel( string $logLevel ): ProfilerInterface;
```
Level at which to log profile messages.
start()
```php
public function start( string $method ): void;
```
Starts a profile entry.
## DataMapper\Query\AbstractConditions
Abstract
Class AbstractConditions
- [`Phalcon\DataMapper\Query\AbstractQuery`](#datamapperqueryabstractquery)
- **`Phalcon\DataMapper\Query\AbstractConditions`**
- [`Phalcon\DataMapper\Query\Delete`](#datamapperquerydelete)
- [`Phalcon\DataMapper\Query\Select`](#datamapperqueryselect)
- [`Phalcon\DataMapper\Query\Update`](#datamapperqueryupdate)
`Phalcon\Contracts\DataMapper\DataMapperTypes`
### Method Summary
- `public andWhere(string $condition, mixed $value = null, int $type = -1): AbstractConditions` — Sets a `AND` for a `WHERE` condition
- `public appendWhere(string $condition, mixed $value = null, int $type = -1): AbstractConditions` — Concatenates to the most recent `WHERE` clause
- `public limit(int $limit): AbstractConditions` — Sets the `LIMIT` clause
- `public offset(int $offset): AbstractConditions` — Sets the `OFFSET` clause
- `public orWhere(string $condition, mixed $value = null, int $type = -1): AbstractConditions` — Sets a `OR` for a `WHERE` condition
- `public orderBy(mixed $orderBy): AbstractConditions` — Sets the `ORDER BY`
- `public where(string $condition, mixed $value = null, int $type = -1): AbstractConditions` — Sets a `WHERE` condition
- `public whereEquals(array $columnsValues): AbstractConditions`
- `protected addCondition(string $store, string $andor, string $condition, mixed $value = null, int $type = -1): void` — Appends a conditional
- `protected appendCondition(string $store, string $condition, mixed $value = null, int $type = -1): void` — Concatenates a conditional
- `protected buildBy(string $type): string` — Builds a `BY` list
- `protected buildCondition(string $type): string` — Builds the conditional string
- `protected buildLimit(): string` — Builds the `LIMIT` clause
- `protected buildLimitCommon(): string` — Builds the `LIMIT` clause for all drivers
- `protected buildLimitEarly(): string` — Builds the early `LIMIT` clause - MS SQLServer
- `protected buildLimitSqlsrv(): string` — Builds the `LIMIT` clause for MSSQLServer
- `protected processValue(string $store, mixed $data): void` — Processes a value (array or string) and merges it with the store
### Methods
andWhere()
```php
public function andWhere(
string $condition,
mixed $value = null,
int $type = -1
): AbstractConditions;
```
Sets a `AND` for a `WHERE` condition
appendWhere()
```php
public function appendWhere(
string $condition,
mixed $value = null,
int $type = -1
): AbstractConditions;
```
Concatenates to the most recent `WHERE` clause
limit()
```php
public function limit( int $limit ): AbstractConditions;
```
Sets the `LIMIT` clause
offset()
```php
public function offset( int $offset ): AbstractConditions;
```
Sets the `OFFSET` clause
orWhere()
```php
public function orWhere(
string $condition,
mixed $value = null,
int $type = -1
): AbstractConditions;
```
Sets a `OR` for a `WHERE` condition
orderBy()
```php
public function orderBy( mixed $orderBy ): AbstractConditions;
```
Sets the `ORDER BY`
where()
```php
public function where(
string $condition,
mixed $value = null,
int $type = -1
): AbstractConditions;
```
Sets a `WHERE` condition
whereEquals()
```php
public function whereEquals( array $columnsValues ): AbstractConditions;
```
addCondition()
```php
protected function addCondition(
string $store,
string $andor,
string $condition,
mixed $value = null,
int $type = -1
): void;
```
Appends a conditional
appendCondition()
```php
protected function appendCondition(
string $store,
string $condition,
mixed $value = null,
int $type = -1
): void;
```
Concatenates a conditional
buildBy()
```php
protected function buildBy( string $type ): string;
```
Builds a `BY` list
buildCondition()
```php
protected function buildCondition( string $type ): string;
```
Builds the conditional string
buildLimit()
```php
protected function buildLimit(): string;
```
Builds the `LIMIT` clause
buildLimitCommon()
```php
protected function buildLimitCommon(): string;
```
Builds the `LIMIT` clause for all drivers
buildLimitEarly()
```php
protected function buildLimitEarly(): string;
```
Builds the early `LIMIT` clause - MS SQLServer
buildLimitSqlsrv()
```php
protected function buildLimitSqlsrv(): string;
```
Builds the `LIMIT` clause for MSSQLServer
processValue()
```php
protected function processValue(
string $store,
mixed $data
): void;
```
Processes a value (array or string) and merges it with the store
## DataMapper\Query\AbstractQuery
Abstract
Class AbstractQuery
- **`Phalcon\DataMapper\Query\AbstractQuery`**
- [`Phalcon\DataMapper\Query\AbstractConditions`](#datamapperqueryabstractconditions)
- [`Phalcon\DataMapper\Query\Insert`](#datamapperqueryinsert)
`Phalcon\Contracts\DataMapper\DataMapperTypes` · `Phalcon\DataMapper\Pdo\Connection`
### Method Summary
- `public __construct(Connection $connection, Bind $bind)` — AbstractQuery constructor.
- `public bindInline(mixed $value, int $type = -1): string` — Binds a value inline
- `public bindValue(string $key, mixed $value, int $type = -1): AbstractQuery` — Binds a value - auto-detects the type if necessary
- `public bindValues(array $values): AbstractQuery` — Binds an array of values
- `public getBindValues(): array` — Returns all the bound values
- `public getStatement(): string` — Return the generated statement
- `public perform()` — Performs a statement in the connection
- `public quoteIdentifier(string $name, int $type = \PDO::PARAM_STR): string` — Quotes the identifier
- `public reset(): void` — Resets the internal array
- `public resetColumns(): void` — Resets the columns
- `public resetFlags(): void` — Resets the flags
- `public resetFrom(): void` — Resets the from
- `public resetGroupBy(): void` — Resets the group by
- `public resetHaving(): void` — Resets the having
- `public resetLimit(): void` — Resets the limit and offset
- `public resetOrderBy(): void` — Resets the order by
- `public resetWhere(): void` — Resets the where
- `public setFlag(string $flag, bool $enable = true): void` — Sets a flag for the query such as "DISTINCT"
- `protected buildFlags()` — Builds the flags statement(s)
- `protected buildReturning(): string` — Builds the `RETURNING` clause
- `protected indent(array $collection, string $glue = ""): string` — Indents a collection
### Properties
- `protected Bind $bind`
- `protected Connection $connection`
- `protected array $store = []`
### Methods
__construct()
```php
public function __construct(
Connection $connection,
Bind $bind
);
```
AbstractQuery constructor.
bindInline()
```php
public function bindInline(
mixed $value,
int $type = -1
): string;
```
Binds a value inline
bindValue()
```php
public function bindValue(
string $key,
mixed $value,
int $type = -1
): AbstractQuery;
```
Binds a value - auto-detects the type if necessary
bindValues()
```php
public function bindValues( array $values ): AbstractQuery;
```
Binds an array of values
getBindValues()
```php
public function getBindValues(): array;
```
Returns all the bound values
getStatement()
```php
abstract public function getStatement(): string;
```
Return the generated statement
```php
public function perform();
```
Performs a statement in the connection
quoteIdentifier()
```php
public function quoteIdentifier(
string $name,
int $type = \PDO::PARAM_STR
): string;
```
Quotes the identifier
reset()
```php
public function reset(): void;
```
Resets the internal array
resetColumns()
```php
public function resetColumns(): void;
```
Resets the columns
resetFlags()
```php
public function resetFlags(): void;
```
Resets the flags
resetFrom()
```php
public function resetFrom(): void;
```
Resets the from
resetGroupBy()
```php
public function resetGroupBy(): void;
```
Resets the group by
resetHaving()
```php
public function resetHaving(): void;
```
Resets the having
resetLimit()
```php
public function resetLimit(): void;
```
Resets the limit and offset
resetOrderBy()
```php
public function resetOrderBy(): void;
```
Resets the order by
resetWhere()
```php
public function resetWhere(): void;
```
Resets the where
setFlag()
```php
public function setFlag(
string $flag,
bool $enable = true
): void;
```
Sets a flag for the query such as "DISTINCT"
buildFlags()
```php
protected function buildFlags();
```
Builds the flags statement(s)
buildReturning()
```php
protected function buildReturning(): string;
```
Builds the `RETURNING` clause
indent()
```php
protected function indent(
array $collection,
string $glue = ""
): string;
```
Indents a collection
## DataMapper\Query\Bind
Class
Class Bind
- **`Phalcon\DataMapper\Query\Bind`**
`Phalcon\Contracts\DataMapper\DataMapperTypes`
### Method Summary
- `public bindInline(mixed $value, int $type = -1): string`
- `public remove(string $key): void` — Removes a value from the store
- `public setValue(string $key, mixed $value, int $type = -1): void` — Sets a value
- `public setValues(array $values, int $type = -1): void` — Sets values from an array
- `public toArray(): array` — Returns the internal collection
- `protected getType(mixed $value): int` — Auto detects the PDO type
- `protected inlineArray(array $data, int $type): string` — Processes an array - if passed as an `inline` parameter
### Properties
- `protected int $inlineCount = 0`
- `protected array $store = []`
### Methods
bindInline()
```php
public function bindInline(
mixed $value,
int $type = -1
): string;
```
remove()
```php
public function remove( string $key ): void;
```
Removes a value from the store
setValue()
```php
public function setValue(
string $key,
mixed $value,
int $type = -1
): void;
```
Sets a value
setValues()
```php
public function setValues(
array $values,
int $type = -1
): void;
```
Sets values from an array
toArray()
```php
public function toArray(): array;
```
Returns the internal collection
getType()
```php
protected function getType( mixed $value ): int;
```
Auto detects the PDO type
inlineArray()
```php
protected function inlineArray(
array $data,
int $type
): string;
```
Processes an array - if passed as an `inline` parameter
## DataMapper\Query\Delete
Class
Delete Query
@property datamapper_write_store $store
- [`Phalcon\DataMapper\Query\AbstractQuery`](#datamapperqueryabstractquery)
- [`Phalcon\DataMapper\Query\AbstractConditions`](#datamapperqueryabstractconditions)
- **`Phalcon\DataMapper\Query\Delete`**
`Phalcon\Contracts\DataMapper\DataMapperTypes` · `Phalcon\DataMapper\Pdo\Connection`
### Method Summary
- `public __construct(Connection $connection, Bind $bind)` — Delete constructor.
- `public from(string $table): Delete` — Adds table(s) in the query
- `public getStatement(): string`
- `public reset(): void` — Resets the internal store
- `public returning(array $columns): Delete` — Adds the `RETURNING` clause
### Methods
__construct()
```php
public function __construct(
Connection $connection,
Bind $bind
);
```
Delete constructor.
from()
```php
public function from( string $table ): Delete;
```
Adds table(s) in the query
getStatement()
```php
public function getStatement(): string;
```
reset()
```php
public function reset(): void;
```
Resets the internal store
returning()
```php
public function returning( array $columns ): Delete;
```
Adds the `RETURNING` clause
## DataMapper\Query\Insert
Class
Insert Query
@property datamapper_write_store $store
- [`Phalcon\DataMapper\Query\AbstractQuery`](#datamapperqueryabstractquery)
- **`Phalcon\DataMapper\Query\Insert`**
`Phalcon\Contracts\DataMapper\DataMapperTypes` · `Phalcon\DataMapper\Pdo\Connection`
### Method Summary
- `public __construct(Connection $connection, Bind $bind)` — Insert constructor.
- `public column(string $column, mixed $value = null, int $type = -1): Insert` — Sets a column for the `INSERT` query
- `public columns(array $columns): Insert` — Mass sets columns and values for the `INSERT`
- `public getLastInsertId(string|null $name = null): string` — Returns the id of the last inserted record
- `public getStatement(): string`
- `public into(string $table): Insert` — Adds table(s) in the query
- `public reset(): void` — Resets the internal store
- `public returning(array $columns): Insert` — Adds the `RETURNING` clause
- `public set(string $column, mixed $value = null): Insert` — Sets a column = value condition
### Methods
__construct()
```php
public function __construct(
Connection $connection,
Bind $bind
);
```
Insert constructor.
column()
```php
public function column(
string $column,
mixed $value = null,
int $type = -1
): Insert;
```
Sets a column for the `INSERT` query
columns()
```php
public function columns( array $columns ): Insert;
```
Mass sets columns and values for the `INSERT`
getLastInsertId()
```php
public function getLastInsertId( string|null $name = null ): string;
```
Returns the id of the last inserted record
getStatement()
```php
public function getStatement(): string;
```
into()
```php
public function into( string $table ): Insert;
```
Adds table(s) in the query
reset()
```php
public function reset(): void;
```
Resets the internal store
returning()
```php
public function returning( array $columns ): Insert;
```
Adds the `RETURNING` clause
set()
```php
public function set(
string $column,
mixed $value = null
): Insert;
```
Sets a column = value condition
## DataMapper\Query\QueryFactory
Class
QueryFactory
- **`Phalcon\DataMapper\Query\QueryFactory`**
`Phalcon\DataMapper\Pdo\Connection`
### Method Summary
- `public __construct(string $selectClass = "")` — QueryFactory constructor.
- `public newBind(): Bind` — Create a new Bind object
- `public newDelete(Connection $connection): Delete` — Create a new Delete object
- `public newInsert(Connection $connection): Insert` — Create a new Insert object
- `public newSelect(Connection $connection): Select` — Create a new Select object
- `public newUpdate(Connection $connection): Update` — Create a new Update object
### Properties
- `protected string $selectClass = ""`
### Methods
__construct()
```php
public function __construct( string $selectClass = "" );
```
QueryFactory constructor.
newBind()
```php
public function newBind(): Bind;
```
Create a new Bind object
newDelete()
```php
public function newDelete( Connection $connection ): Delete;
```
Create a new Delete object
newInsert()
```php
public function newInsert( Connection $connection ): Insert;
```
Create a new Insert object
newSelect()
```php
public function newSelect( Connection $connection ): Select;
```
Create a new Select object
newUpdate()
```php
public function newUpdate( Connection $connection ): Update;
```
Create a new Update object
## DataMapper\Query\Select
Class
Select Query
@property datamapper_select_store $store
- [`Phalcon\DataMapper\Query\AbstractQuery`](#datamapperqueryabstractquery)
- [`Phalcon\DataMapper\Query\AbstractConditions`](#datamapperqueryabstractconditions)
- **`Phalcon\DataMapper\Query\Select`**
`BadMethodCallException` · `Phalcon\Contracts\DataMapper\DataMapperTypes` · `Phalcon\DataMapper\Pdo\Exception\UnknownQueryMethod`
### Method Summary
- `public __call(string $method, array $params)` — Proxied methods to the connection
- `public andHaving(string $condition, mixed $value = null, int $type = -1): Select` — Sets a `AND` for a `HAVING` condition
- `public appendHaving(string $condition, mixed $value = null, int $type = -1): Select` — Concatenates to the most recent `HAVING` clause
- `public appendJoin(string $condition, mixed $value = null, int $type = -1): Select` — Concatenates to the most recent `JOIN` clause
- `public asAlias(string $asAlias): Select` — The `AS` statement for the query - useful in sub-queries
- `public columns(array $columns): Select` — The columns to select from. If a key is set in the array element, the
- `public distinct(bool $enable = true): Select`
- `public forUpdate(bool $enable = true): Select` — Enable the `FOR UPDATE` for the query
- `public from(string $table): Select` — Adds table(s) in the query
- `public getStatement(): string` — Returns the compiled SQL statement
- `public groupBy(mixed $groupBy): Select` — Sets the `GROUP BY`
- `public hasColumns(): bool` — Whether the query has columns or not
- `public having(string $condition, mixed $value = null, int $type = -1): Select` — Sets a `HAVING` condition
- `public join(string $join, string $table, string $condition, mixed $value = null, int $type = -1): Select` — Sets a 'JOIN' condition
- `public orHaving(string $condition, mixed $value = null, int $type = -1): Select` — Sets a `OR` for a `HAVING` condition
- `public reset(): void` — Resets the internal collections
- `public subSelect(): Select` — Start a sub-select
- `public union(): Select` — Start a `UNION`
- `public unionAll(): Select` — Start a `UNION ALL`
- `protected getCurrentStatement(string $suffix = ""): string` — Statement builder
### Constants
- `const string JOIN_INNER = "INNER"`
- `const string JOIN_LEFT = "LEFT"`
- `const string JOIN_NATURAL = "NATURAL"`
- `const string JOIN_RIGHT = "RIGHT"`
### Properties
- `protected string $asAlias = ""`
- `protected bool $forUpdate = false`
### Methods
__call()
```php
public function __call(
string $method,
array $params
);
```
Proxied methods to the connection
andHaving()
```php
public function andHaving(
string $condition,
mixed $value = null,
int $type = -1
): Select;
```
Sets a `AND` for a `HAVING` condition
appendHaving()
```php
public function appendHaving(
string $condition,
mixed $value = null,
int $type = -1
): Select;
```
Concatenates to the most recent `HAVING` clause
appendJoin()
```php
public function appendJoin(
string $condition,
mixed $value = null,
int $type = -1
): Select;
```
Concatenates to the most recent `JOIN` clause
asAlias()
```php
public function asAlias( string $asAlias ): Select;
```
The `AS` statement for the query - useful in sub-queries
columns()
```php
public function columns( array $columns ): Select;
```
The columns to select from. If a key is set in the array element, the
key will be used as the alias
distinct()
```php
public function distinct( bool $enable = true ): Select;
```
forUpdate()
```php
public function forUpdate( bool $enable = true ): Select;
```
Enable the `FOR UPDATE` for the query
from()
```php
public function from( string $table ): Select;
```
Adds table(s) in the query
getStatement()
```php
public function getStatement(): string;
```
Returns the compiled SQL statement
groupBy()
```php
public function groupBy( mixed $groupBy ): Select;
```
Sets the `GROUP BY`
hasColumns()
```php
public function hasColumns(): bool;
```
Whether the query has columns or not
having()
```php
public function having(
string $condition,
mixed $value = null,
int $type = -1
): Select;
```
Sets a `HAVING` condition
join()
```php
public function join(
string $join,
string $table,
string $condition,
mixed $value = null,
int $type = -1
): Select;
```
Sets a 'JOIN' condition
orHaving()
```php
public function orHaving(
string $condition,
mixed $value = null,
int $type = -1
): Select;
```
Sets a `OR` for a `HAVING` condition
reset()
```php
public function reset(): void;
```
Resets the internal collections
subSelect()
```php
public function subSelect(): Select;
```
Start a sub-select
union()
```php
public function union(): Select;
```
Start a `UNION`
unionAll()
```php
public function unionAll(): Select;
```
Start a `UNION ALL`
getCurrentStatement()
```php
protected function getCurrentStatement( string $suffix = "" ): string;
```
Statement builder
## DataMapper\Query\Update
Class
Update Query
@property datamapper_write_store $store
- [`Phalcon\DataMapper\Query\AbstractQuery`](#datamapperqueryabstractquery)
- [`Phalcon\DataMapper\Query\AbstractConditions`](#datamapperqueryabstractconditions)
- **`Phalcon\DataMapper\Query\Update`**
`Phalcon\Contracts\DataMapper\DataMapperTypes` · `Phalcon\DataMapper\Pdo\Connection`
### Method Summary
- `public __construct(Connection $connection, Bind $bind)` — Update constructor.
- `public column(string $column, mixed $value = null, int $type = -1): Update` — Sets a column for the `UPDATE` query
- `public columns(array $columns): Update` — Mass sets columns and values for the `UPDATE`
- `public from(string $table): Update` — Adds table(s) in the query
- `public getStatement(): string`
- `public hasColumns(): bool` — Whether the query has columns or not
- `public reset(): void` — Resets the internal store
- `public returning(array $columns): Update` — Adds the `RETURNING` clause
- `public set(string $column, mixed $value = null): Update` — Sets a column = value condition
### Methods
__construct()
```php
public function __construct(
Connection $connection,
Bind $bind
);
```
Update constructor.
column()
```php
public function column(
string $column,
mixed $value = null,
int $type = -1
): Update;
```
Sets a column for the `UPDATE` query
columns()
```php
public function columns( array $columns ): Update;
```
Mass sets columns and values for the `UPDATE`
from()
```php
public function from( string $table ): Update;
```
Adds table(s) in the query
getStatement()
```php
public function getStatement(): string;
```
hasColumns()
```php
public function hasColumns(): bool;
```
Whether the query has columns or not
reset()
```php
public function reset(): void;
```
Resets the internal store
returning()
```php
public function returning( array $columns ): Update;
```
Adds the `RETURNING` clause
set()
```php
public function set(
string $column,
mixed $value = null
): Update;
```
Sets a column = value condition
Source: https://docs.phalcon.io/5.23/api/phalcon_datamapper/index.mdx