Phalcon Datamapper

DataMapper\Pdo\Connection

Provides array quoting, profiling, a new perform() method, new fetch*() methods

Uses Phalcon\DataMapper\Pdo\Connection\AbstractConnection · Phalcon\DataMapper\Pdo\Exception\DriverNotSupported · Phalcon\DataMapper\Pdo\Profiler\Profiler · Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface

Method Summary

Properties

Methods

__construct()

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()

public function __debugInfo(): array;

The purpose of this method is to hide sensitive data from stack traces.

connect()

public function connect(): void;

Connects to the database.

disconnect()

public function disconnect(): void;

Disconnects from the database.

DataMapper\Pdo\ConnectionLocator

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.

Uses Phalcon\Contracts\Events\EventsAware · Phalcon\DataMapper\Pdo\Connection\ConnectionInterface · Phalcon\DataMapper\Pdo\Exception\ConnectionNotFound · Phalcon\Events\ManagerInterface · Phalcon\Events\Traits\EventsAwareTrait

Method Summary

Properties

Methods

__construct()

public function __construct(
    ConnectionInterface $master,
    array $read = [],
    array $write = []
);

Constructor.

getMaster()

public function getMaster(): ConnectionInterface;

Returns the default connection object.

getRead()

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()

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()

public function setMaster( ConnectionInterface $callableObject ): static;

Sets the default connection factory.

setRead()

public function setRead(
    string $name,
    callable $callableObject
): static;

Sets a read connection factory by name.

setWrite()

public function setWrite(
    string $name,
    callable $callableObject
): static;

Sets a write connection factory by name.

getConnection()

protected function getConnection(
    string $type,
    string $name = ""
): ConnectionInterface;

Returns a connection by name.

DataMapper\Pdo\ConnectionLocatorInterface

Locates PDO connections for default, read, and write databases.

Uses Phalcon\DataMapper\Pdo\Connection\ConnectionInterface

Method Summary

Methods

getMaster()

public function getMaster(): ConnectionInterface;

Returns the default connection object.

getRead()

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()

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()

public function setMaster( ConnectionInterface $callableObject ): ConnectionLocatorInterface;

Sets the default connection registry entry.

setRead()

public function setRead(
    string $name,
    callable $callableObject
): ConnectionLocatorInterface;

Sets a read connection registry entry by name.

setWrite()

public function setWrite(
    string $name,
    callable $callableObject
): ConnectionLocatorInterface;

Sets a write connection registry entry by name.

DataMapper\Pdo\Connection\AbstractConnection

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.

Uses BadMethodCallException · 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

Method Summary

Properties

Methods

__call()

public function __call(
    mixed $name,
    array $arguments
);

Proxies to PDO methods created for specific drivers; in particular, sqlite and pgsql.

beginTransaction()

public function beginTransaction(): bool;

Begins a transaction. If the profiler is enabled, the operation will be recorded.

commit()

public function commit(): bool;

Commits the existing transaction. If the profiler is enabled, the operation will be recorded.

connect()

abstract public function connect(): void;

Connects to the database.

disconnect()

abstract public function disconnect(): void;

Disconnects from the database.

ensureConnection()

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()

public function errorCode(): string|null;

Gets the most recent error code.

errorInfo()

public function errorInfo(): array;

Gets the most recent error info.

exec()

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()

public function fetchAffected(
    string $statement,
    array $values = []
): int;

Performs a statement and returns the number of affected rows.

fetchAll()

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()

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()

public function fetchColumn(
    string $statement,
    array $values = [],
    int $column = 0
): array;

Fetches a column of rows as a sequential array (default first one).

fetchGroup()

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()

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

fetchObjects()

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()

public function fetchOne(
    string $statement,
    array $values = []
): array;

Fetches one row from the database as an associative array.

fetchPairs()

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()

public function fetchValue(
    string $statement,
    array $values = []
);

Fetches the very first value (i.e., first column of the first row).

getAdapter()

public function getAdapter(): \PDO;

Return the inner PDO (if any)

getAttribute()

public function getAttribute( int $attribute ): mixed;

Retrieve a database connection attribute

getAutoReconnect()

public function getAutoReconnect(): bool;

Returns whether transparent auto-reconnect is enabled.

getAvailableDrivers()

public static function getAvailableDrivers(): array;

Return an array of available PDO drivers (empty array if none available)

getDriverName()

public function getDriverName(): string;

Return the driver name

getProfiler()

public function getProfiler(): ProfilerInterface;

Returns the Profiler instance.

getQuoteNames()

public function getQuoteNames( string $driver = "" ): array;

Gets the quote parameters based on the driver

inTransaction()

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()

public function isConnected(): bool;

Is the PDO connection active?

lastInsertId()

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.

perform()

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()

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()

public function prepare(
    string $statement,
    array $options = []
): \PDOStatement|bool;

Prepares an SQL statement for execution.

query()

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()

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()

public function rollBack(): bool;

Rolls back the current transaction, and restores autocommit mode. If the profiler is enabled, the operation will be recorded.

setAttribute()

public function setAttribute(
    int $attribute,
    mixed $value
): bool;

Set a database connection attribute

setAutoReconnect()

public function setAutoReconnect( bool $autoReconnect ): static;

Enables or disables transparent auto-reconnect on a lost connection.

setProfiler()

public function setProfiler( ProfilerInterface $profiler ): static;

Sets the Profiler instance.

fetchData()

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()

protected function fireBefore(
    string $eventName,
    mixed $data = null
): void;

Fires a cancellable “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 cancelled.

isConnectionError()

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.

performBind()

protected function performBind(
    \PDOStatement $statement,
    mixed $name,
    mixed $arguments
): void;

Bind a value using the proper PDO::PARAM_* type.

DataMapper\Pdo\Connection\ConnectionInterface

Provides array quoting, profiling, a new perform() method, new fetch*() methods

Uses Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface

Method Summary

Methods

connect()

public function connect(): void;

Connects to the database.

disconnect()

public function disconnect(): void;

Disconnects from the database.

fetchAffected()

public function fetchAffected(
    string $statement,
    array $values = []
): int;

Performs a statement and returns the number of affected rows.

fetchAll()

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()

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()

public function fetchColumn(
    string $statement,
    array $values = [],
    int $column = 0
): array;

Fetches a column of rows as a sequential array (default first one).

fetchGroup()

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()

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

fetchObjects()

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()

public function fetchOne(
    string $statement,
    array $values = []
): array;

Fetches one row from the database as an associative array.

fetchPairs()

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()

public function fetchValue(
    string $statement,
    array $values = []
): mixed;

Fetches the very first value (i.e., first column of the first row).

getAdapter()

public function getAdapter(): \PDO;

Return the inner PDO (if any)

getProfiler()

public function getProfiler(): ProfilerInterface;

Returns the Profiler instance.

isConnected()

public function isConnected(): bool;

Is the PDO connection active?

perform()

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()

public function setProfiler( ProfilerInterface $profiler );

Sets the Profiler instance.

DataMapper\Pdo\Connection\Decorated

Decorates an existing PDO instance with the extended methods.

Uses Phalcon\DataMapper\Pdo\Exception\CannotDisconnect · Phalcon\DataMapper\Pdo\Profiler\Profiler · Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface

Method Summary

Methods

__construct()

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()

public function connect(): void;

Connects to the database.

disconnect()

public function disconnect(): void;

Disconnects from the database; disallowed with decorated PDO connections.

DataMapper\Pdo\Connection\PdoInterface

An interface to the native PDO object.

Method Summary

Methods

beginTransaction()

public function beginTransaction(): bool;

Begins a transaction. If the profiler is enabled, the operation will be recorded.

commit()

public function commit(): bool;

Commits the existing transaction. If the profiler is enabled, the operation will be recorded.

errorCode()

public function errorCode(): null|string;

Gets the most recent error code.

errorInfo()

public function errorInfo(): array;

Gets the most recent error info.

exec()

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()

public function getAttribute( int $attribute ): mixed;

Retrieve a database connection attribute

getAvailableDrivers()

public static function getAvailableDrivers(): array;

Return an array of available PDO drivers (empty array if none available)

inTransaction()

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()

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()

public function prepare(
    string $statement,
    array $options = []
): \PDOStatement|bool;

Prepares an SQL statement for execution.

query()

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()

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()

public function rollBack(): bool;

Rolls back the current transaction, and restores autocommit mode. If the profiler is enabled, the operation will be recorded.

setAttribute()

public function setAttribute(
    int $attribute,
    mixed $value
): bool;

Set a database connection attribute

DataMapper\Pdo\Events

Lifecycle event names fired by the DataMapper connections through Phalcon\Events\Manager. One public constant per event.

The before* events are cancellable. 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 cancelled operation throws Phalcon\DataMapper\Pdo\Exception\OperationCancelled.

The after* events are not cancellable. 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.

Constants

DataMapper\Pdo\Exception\CannotDisconnect

ExtendedPdo could not disconnect; e.g., because its PDO connection was created externally and then injected.

DataMapper\Pdo\Exception\ConnectionNotFound

Locator could not find a named connection.

DataMapper\Pdo\Exception\DriverNotSupported

Uses InvalidArgumentException

Method Summary

Methods

__construct()

public function __construct( string $driver );

DataMapper\Pdo\Exception\Exception

Base Exception class

DataMapper\Pdo\Exception\OperationCancelled

A listener cancelled a cancellable “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.

Method Summary

Methods

__construct()

public function __construct( string $eventName );

DataMapper\Pdo\Exception\UnknownDriverMethod

Uses BadMethodCallException

Method Summary

Methods

__construct()

public function __construct( string $message );

DataMapper\Pdo\Exception\UnknownQueryMethod

Uses BadMethodCallException

Method Summary

Methods

__construct()

public function __construct( string $method );

DataMapper\Pdo\Profiler\MemoryLogger

A memory-based logger.

Uses Phalcon\Logger\Adapter\AdapterInterface · Phalcon\Logger\Adapter\Noop · Phalcon\Logger\Enum · Phalcon\Logger\LoggerInterface

Method Summary

Properties

Methods

alert()

public function alert(
    string $message,
    array $context = []
): void;

critical()

public function critical(
    string $message,
    array $context = []
): void;

debug()

public function debug(
    string $message,
    array $context = []
): void;

emergency()

public function emergency(
    string $message,
    array $context = []
): void;

error()

public function error(
    string $message,
    array $context = []
): void;

getAdapter()

public function getAdapter( string $name ): AdapterInterface;

Returns an adapter from the stack

getAdapters()

public function getAdapters(): array;

Returns the adapter stack array

getLogLevel()

public function getLogLevel(): int;

Returns the log level

getMessages()

public function getMessages(): array;

Returns the logged messages.

getName()

public function getName(): string;

Returns the name of the logger

info()

public function info(
    string $message,
    array $context = []
): void;

log()

public function log(
    mixed $level,
    string $message,
    array $context = []
): void;

Logs a message.

notice()

public function notice(
    string $message,
    array $context = []
): void;

trace()

public function trace(
    string $message,
    array $context = []
): void;

warning()

public function warning(
    string $message,
    array $context = []
): void;

DataMapper\Pdo\Profiler\Profiler

Sends query profiles to a logger.

Uses Phalcon\DataMapper\Pdo\Exception\Exception · Phalcon\Logger\Enum · Phalcon\Logger\LoggerInterface · Phalcon\Support\Helper\Json\Encode

Method Summary

Properties

Methods

__construct()

public function __construct( LoggerInterface|null $logger = null );

Constructor.

finish()

public function finish(
    string|null $statement = null,
    array $values = []
): void;

Finishes and logs a profile entry.

getLogFormat()

public function getLogFormat(): string;

Returns the log message format string, with placeholders.

getLogLevel()

public function getLogLevel(): string;

Returns the level at which to log profile messages.

getLogger()

public function getLogger(): LoggerInterface;

Returns the underlying logger instance.

isActive()

public function isActive(): bool;

Returns true if logging is active.

setActive()

public function setActive( bool $active ): ProfilerInterface;

Enable or disable profiler logging.

setLogFormat()

public function setLogFormat( string $logFormat ): ProfilerInterface;

Sets the log message format string, with placeholders.

setLogLevel()

public function setLogLevel( string $logLevel ): ProfilerInterface;

Level at which to log profile messages.

start()

public function start( string $method ): void;

Starts a profile entry.

DataMapper\Pdo\Profiler\ProfilerInterface

Interface to send query profiles to a logger.

Uses Phalcon\Logger\LoggerInterface

Method Summary

Methods

finish()

public function finish(
    string|null $statement = null,
    array $values = []
): void;

Finishes and logs a profile entry.

getLogFormat()

public function getLogFormat(): string;

Returns the log message format string, with placeholders.

getLogLevel()

public function getLogLevel(): string;

Returns the level at which to log profile messages.

getLogger()

public function getLogger(): LoggerInterface;

Returns the underlying logger instance.

isActive()

public function isActive(): bool;

Returns true if logging is active.

setActive()

public function setActive( bool $active ): ProfilerInterface;

Enable or disable profiler logging.

setLogFormat()

public function setLogFormat( string $logFormat ): ProfilerInterface;

Sets the log message format string, with placeholders.

setLogLevel()

public function setLogLevel( string $logLevel ): ProfilerInterface;

Level at which to log profile messages.

start()

public function start( string $method ): void;

Starts a profile entry.

DataMapper\Query\AbstractConditions

Class AbstractConditions

Method Summary

Methods

andWhere()

public function andWhere(
    string $condition,
    mixed $value = null,
    int $type = -1
): AbstractConditions;

Sets a AND for a WHERE condition

appendWhere()

public function appendWhere(
    string $condition,
    mixed $value = null,
    int $type = -1
): AbstractConditions;

Concatenates to the most recent WHERE clause

limit()

public function limit( int $limit ): AbstractConditions;

Sets the LIMIT clause

offset()

public function offset( int $offset ): AbstractConditions;

Sets the OFFSET clause

orWhere()

public function orWhere(
    string $condition,
    mixed $value = null,
    int $type = -1
): AbstractConditions;

Sets a OR for a WHERE condition

orderBy()

public function orderBy( mixed $orderBy ): AbstractConditions;

Sets the ORDER BY

where()

public function where(
    string $condition,
    mixed $value = null,
    int $type = -1
): AbstractConditions;

Sets a WHERE condition

whereEquals()

public function whereEquals( array $columnsValues ): AbstractConditions;

addCondition()

protected function addCondition(
    string $store,
    string $andor,
    string $condition,
    mixed $value = null,
    int $type = -1
): void;

Appends a conditional

appendCondition()

protected function appendCondition(
    string $store,
    string $condition,
    mixed $value = null,
    int $type = -1
): void;

Concatenates a conditional

buildBy()

protected function buildBy( string $type ): string;

Builds a BY list

buildCondition()

protected function buildCondition( string $type ): string;

Builds the conditional string

buildLimit()

protected function buildLimit(): string;

Builds the LIMIT clause

buildLimitCommon()

protected function buildLimitCommon(): string;

Builds the LIMIT clause for all drivers

buildLimitEarly()

protected function buildLimitEarly(): string;

Builds the early LIMIT clause - MS SQLServer

buildLimitSqlsrv()

protected function buildLimitSqlsrv(): string;

Builds the LIMIT clause for MSSQLServer

processValue()

protected function processValue(
    string $store,
    mixed $data
): void;

Processes a value (array or string) and merges it with the store

DataMapper\Query\AbstractQuery

Class AbstractQuery

Uses Phalcon\DataMapper\Pdo\Connection

Method Summary

Properties

Methods

__construct()

public function __construct(
    Connection $connection,
    Bind $bind
);

AbstractQuery constructor.

bindInline()

public function bindInline(
    mixed $value,
    int $type = -1
): string;

Binds a value inline

bindValue()

public function bindValue(
    string $key,
    mixed $value,
    int $type = -1
): AbstractQuery;

Binds a value - auto-detects the type if necessary

bindValues()

public function bindValues( array $values ): AbstractQuery;

Binds an array of values

getBindValues()

public function getBindValues(): array;

Returns all the bound values

getStatement()

abstract public function getStatement(): string;

Return the generated statement

perform()

public function perform();

Performs a statement in the connection

quoteIdentifier()

public function quoteIdentifier(
    string $name,
    int $type = \PDO::PARAM_STR
): string;

Quotes the identifier

reset()

public function reset(): void;

Resets the internal array

resetColumns()

public function resetColumns(): void;

Resets the columns

resetFlags()

public function resetFlags(): void;

Resets the flags

resetFrom()

public function resetFrom(): void;

Resets the from

resetGroupBy()

public function resetGroupBy(): void;

Resets the group by

resetHaving()

public function resetHaving(): void;

Resets the having

resetLimit()

public function resetLimit(): void;

Resets the limit and offset

resetOrderBy()

public function resetOrderBy(): void;

Resets the order by

resetWhere()

public function resetWhere(): void;

Resets the where

setFlag()

public function setFlag(
    string $flag,
    bool $enable = true
): void;

Sets a flag for the query such as “DISTINCT”

buildFlags()

protected function buildFlags();

Builds the flags statement(s)

buildReturning()

protected function buildReturning(): string;

Builds the RETURNING clause

indent()

protected function indent(
    array $collection,
    string $glue = ""
): string;

Indents a collection

DataMapper\Query\Bind

Class Bind

Method Summary

Properties

Methods

bindInline()

public function bindInline(
    mixed $value,
    int $type = -1
): string;

remove()

public function remove( string $key ): void;

Removes a value from the store

setValue()

public function setValue(
    string $key,
    mixed $value,
    int $type = -1
): void;

Sets a value

setValues()

public function setValues(
    array $values,
    int $type = -1
): void;

Sets values from an array

toArray()

public function toArray(): array;

Returns the internal collection

getType()

protected function getType( mixed $value ): int;

Auto detects the PDO type

inlineArray()

protected function inlineArray(
    array $data,
    int $type
): string;

Processes an array - if passed as an inline parameter

DataMapper\Query\Delete

Delete Query

Uses Phalcon\DataMapper\Pdo\Connection

Method Summary

Methods

__construct()

public function __construct(
    Connection $connection,
    Bind $bind
);

Delete constructor.

from()

public function from( string $table ): Delete;

Adds table(s) in the query

getStatement()

public function getStatement(): string;

reset()

public function reset(): void;

Resets the internal store

returning()

public function returning( array $columns ): Delete;

Adds the RETURNING clause

DataMapper\Query\Insert

Insert Query

Uses Phalcon\DataMapper\Pdo\Connection

Method Summary

Methods

__construct()

public function __construct(
    Connection $connection,
    Bind $bind
);

Insert constructor.

column()

public function column(
    string $column,
    mixed $value = null,
    int $type = -1
): Insert;

Sets a column for the INSERT query

columns()

public function columns( array $columns ): Insert;

Mass sets columns and values for the INSERT

getLastInsertId()

public function getLastInsertId( string|null $name = null ): string;

Returns the id of the last inserted record

getStatement()

public function getStatement(): string;

into()

public function into( string $table ): Insert;

Adds table(s) in the query

reset()

public function reset(): void;

Resets the internal store

returning()

public function returning( array $columns ): Insert;

Adds the RETURNING clause

set()

public function set(
    string $column,
    mixed $value = null
): Insert;

Sets a column = value condition

DataMapper\Query\QueryFactory

QueryFactory

Uses Phalcon\DataMapper\Pdo\Connection

Method Summary

Properties

Methods

__construct()

public function __construct( string $selectClass = "" );

QueryFactory constructor.

newBind()

public function newBind(): Bind;

Create a new Bind object

newDelete()

public function newDelete( Connection $connection ): Delete;

Create a new Delete object

newInsert()

public function newInsert( Connection $connection ): Insert;

Create a new Insert object

newSelect()

public function newSelect( Connection $connection ): Select;

Create a new Select object

newUpdate()

public function newUpdate( Connection $connection ): Update;

Create a new Update object

DataMapper\Query\Select

Select Query

Uses BadMethodCallException · Phalcon\DataMapper\Pdo\Exception\UnknownQueryMethod

Method Summary

Constants

Properties

Methods

__call()

public function __call(
    string $method,
    array $params
);

Proxied methods to the connection

andHaving()

public function andHaving(
    string $condition,
    mixed $value = null,
    int $type = -1
): Select;

Sets a AND for a HAVING condition

appendHaving()

public function appendHaving(
    string $condition,
    mixed $value = null,
    int $type = -1
): Select;

Concatenates to the most recent HAVING clause

appendJoin()

public function appendJoin(
    string $condition,
    mixed $value = null,
    int $type = -1
): Select;

Concatenates to the most recent JOIN clause

asAlias()

public function asAlias( string $asAlias ): Select;

The AS statement for the query - useful in sub-queries

columns()

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()

public function distinct( bool $enable = true ): Select;

forUpdate()

public function forUpdate( bool $enable = true ): Select;

Enable the FOR UPDATE for the query

from()

public function from( string $table ): Select;

Adds table(s) in the query

getStatement()

public function getStatement(): string;

Returns the compiled SQL statement

groupBy()

public function groupBy( mixed $groupBy ): Select;

Sets the GROUP BY

hasColumns()

public function hasColumns(): bool;

Whether the query has columns or not

having()

public function having(
    string $condition,
    mixed $value = null,
    int $type = -1
): Select;

Sets a HAVING condition

join()

public function join(
    string $join,
    string $table,
    string $condition,
    mixed $value = null,
    int $type = -1
): Select;

Sets a ‘JOIN’ condition

orHaving()

public function orHaving(
    string $condition,
    mixed $value = null,
    int $type = -1
): Select;

Sets a OR for a HAVING condition

reset()

public function reset(): void;

Resets the internal collections

subSelect()

public function subSelect(): Select;

Start a sub-select

union()

public function union(): Select;

Start a UNION

unionAll()

public function unionAll(): Select;

Start a UNION ALL

getCurrentStatement()

protected function getCurrentStatement( string $suffix = "" ): string;

Statement builder

DataMapper\Query\Update

Update Query

Uses Phalcon\DataMapper\Pdo\Connection

Method Summary

Methods

__construct()

public function __construct(
    Connection $connection,
    Bind $bind
);

Update constructor.

column()

public function column(
    string $column,
    mixed $value = null,
    int $type = -1
): Update;

Sets a column for the UPDATE query

columns()

public function columns( array $columns ): Update;

Mass sets columns and values for the UPDATE

from()

public function from( string $table ): Update;

Adds table(s) in the query

getStatement()

public function getStatement(): string;

hasColumns()

public function hasColumns(): bool;

Whether the query has columns or not

reset()

public function reset(): void;

Resets the internal store

returning()

public function returning( array $columns ): Update;

Adds the RETURNING clause

set()

public function set(
    string $column,
    mixed $value = null
): Update;

Sets a column = value condition