Phalcon contracts

Contracts\Assets\Asset¶

Interface Source on GitHub

Canonical contract for Phalcon\Assets\Asset.

Covers collection membership: an asset's key, type, HTML attributes, and filter flag. The file-output pipeline (Phalcon\Assets\Manager::output()) requires the concrete Phalcon\Assets\Asset class.

Method Summary¶

Methods¶

getAssetKey()¶

public function getAssetKey(): string;

Gets the asset's key.

getAttributes()¶

public function getAttributes(): array|null;

Gets extra HTML attributes.

getFilter()¶

public function getFilter(): bool;

Gets if the asset must be filtered or not.

getType()¶

public function getType(): string;

Gets the asset's type.

setAttributes()¶

public function setAttributes( array $attributes ): Asset;

Sets extra HTML attributes.

setFilter()¶

public function setFilter( bool $filter ): Asset;

Sets if the asset must be filtered or not.

setType()¶

public function setType( string $type ): Asset;

Sets the asset's type.

Contracts\Assets\Filter¶

Interface Source on GitHub

Canonical contract for Phalcon\Assets filters (Cssmin, Jsmin, None, and custom user filters).

Method Summary¶

Methods¶

filter()¶

public function filter( string $content ): string;

Filters the content returning a string with the filtered content

Contracts\Auth\Access\Access¶

Interface Source on GitHub

Access gates are Specifications: policies that decide whether the current identity may run the given action. The enforcement point passes the identity (the guard) and the request context on every call; gates hold no reference to the auth manager.

Uses Phalcon\Contracts\Auth\Guard\Guard

Method Summary¶

Methods¶

getExceptActions()¶

public function getExceptActions(): array;

getOnlyActions()¶

public function getOnlyActions(): array;

isAllowed()¶

public function isAllowed(
    Guard $guard,
    string $actionName,
    array $context = []
): bool;

Whether the identity behind the guard may run the action.

redirectTo()¶

public function redirectTo(): array|null;

setExceptActions()¶

public function setExceptActions( array $exceptActions = [] ): void;

Exempts the listed action names from the gate; every other action is checked. See setOnlyActions() for the gate-family divergence note.

setOnlyActions()¶

public function setOnlyActions( array $onlyActions = [] ): void;

Restricts the gate to the listed action names.

Authoritative semantics: the gate applies only to the listed actions; an action that is not listed passes without a check (and except() is the inverse - the gate applies to every action except those listed).

NOTE: the implementations currently diverge. The Acl gate follows the authoritative semantics above, while the binary gates (Auth, Guest) treat only as a whitelist - an unlisted action is denied even when the base condition holds. The two gate families will be aligned in the next major version; until then, choose the gate family deliberately, because for an unlisted action they return opposite answers to the same call.

Contracts\Auth\Adapter\Adapter¶

Interface Source on GitHub

Authentication adapter contract.

Adapters look users up by credentials or by identifier and verify the password against the stored hash. The credential payload is intentionally unsealed: any user-row field may be used as the lookup key, plus an optional password entry that is ignored during the row match and consumed only by validateCredentials().

Uses Phalcon\Contracts\Auth\AuthUser · Phalcon\Contracts\Encryption\Security\Security

Method Summary¶

Methods¶

fromOptions()¶

public static function fromOptions(
    Security $hasher,
    array $options
): static;

Build an adapter from a flat options map. Used by ManagerFactory to wire adapters from the application config; each implementation is free to interpret the option keys it cares about.

retrieveByCredentials()¶

public function retrieveByCredentials( array $credentials ): AuthUser|null;

Find a user matching the given credentials (e.g. ['email' => 'a@b']). The 'password' key, if present, is ignored during the lookup. Returns null if no user matches.

retrieveById()¶

public function retrieveById( mixed $id ): AuthUser|null;

Find a user by their unique identifier.

validateCredentials()¶

public function validateCredentials(
    AuthUser $user,
    array $credentials
): bool;

Validate the provided credentials against the given user. Implementations typically verify the password hash held under the 'password' key.

Contracts\Auth\Adapter\AdapterConfig¶

Interface Source on GitHub

Authentication adapter configuration contract.

Per-adapter config shape is intentionally adapter-specific (e.g. Stream exposes getFile(), Memory exposes getUsers()); the only field shared across all adapters is the optional model class used during user hydration.

Method Summary¶

Methods¶

getModel()¶

public function getModel(): string|null;

Returns the user-model class name to hydrate, if configured.

Contracts\Auth\Adapter\RememberAdapter¶

Interface Source on GitHub

Capability extension implemented by adapters that support remember-me.

Uses Phalcon\Contracts\Auth\AuthUser · Phalcon\Contracts\Auth\RememberToken

Method Summary¶

Methods¶

createRememberToken()¶

public function createRememberToken( AuthUser $user ): RememberToken;

Create and persist a new remember token for the user.

retrieveByToken()¶

public function retrieveByToken(
    mixed $id,
    string $token,
    string $userAgent = null
): AuthUser|null;

Retrieve a user by the remember-me cookie payload.

Contracts\Auth\AuthRemember¶

Interface Source on GitHub

Implemented by authenticatable models that support remember-me tokens. This is intentionally separate from AuthUser so that adapters which do not support remember-me are not forced to implement it.

Method Summary¶

Methods¶

createRememberToken()¶

public function createRememberToken(
    string $token,
    string $userAgent = null
): RememberToken;

Persists a new remember token for the user.

getRememberToken()¶

public function getRememberToken( string $token ): RememberToken|null;

Returns the remember token entry matching the given token value, or null if not found.

Contracts\Auth\AuthUser¶

Interface Source on GitHub

Implemented by user models that can be authenticated.

Method Summary¶

Methods¶

getAuthIdentifier()¶

public function getAuthIdentifier(): int|string;

Returns the unique identifier for the authenticatable user (e.g. the primary key). Implementations MUST return a non-null scalar; if a record cannot produce one, the implementation should fail at construction time rather than returning null.

getAuthPassword()¶

public function getAuthPassword(): string;

Returns the hashed password for the authenticatable user.

Contracts\Auth\Guard\BasicAuth¶

Interface Source on GitHub

Uses Phalcon\Contracts\Auth\AuthUser

Method Summary¶

Methods¶

basic()¶

public function basic(
    string $field = "email",
    array $extraConditions = []
): bool;

Authenticate against HTTP Basic credentials. Returns true on success.

onceBasic()¶

public function onceBasic(
    string $field = "email",
    array $extraConditions = []
): false|AuthUser;

Like basic() but does not persist; returns the resolved user on success or false on failure.

Contracts\Auth\Guard\Guard¶

Interface Source on GitHub

Uses Phalcon\Contracts\Auth\Adapter\Adapter · Phalcon\Contracts\Auth\AuthUser · Phalcon\Contracts\Container\Service\Collection · Phalcon\Di\DiInterface

Method Summary¶

Methods¶

check()¶

public function check(): bool;

Whether the current request is authenticated.

fromOptions()¶

public static function fromOptions(
    Adapter $adapter,
    mixed $container,
    array $options
): static;

Build a guard from an adapter, the application container, and a flat options map. Used by ManagerFactory to wire guards from the application config; each implementation resolves the framework services it needs from the container.

The container is Container-first: pass a Phalcon\Container\Container. The legacy Phalcon\Di\Di is also supported with provisions - its service definitions must be pre-registered (no autowiring).

getLastUserAttempted()¶

public function getLastUserAttempted(): AuthUser|null;

Returns the last user the guard tried to authenticate during this request, regardless of success.

guest()¶

public function guest(): bool;

Whether the current request is unauthenticated.

hasUser()¶

public function hasUser(): bool;

Whether the guard currently holds a resolved user.

id()¶

public function id(): int|string|null;

Returns the authenticated user's identifier, or null when no authenticated user is present.

setUser()¶

public function setUser( AuthUser $user ): static;

Sets the current user explicitly. Returns $this for fluent chaining.

user()¶

public function user(): AuthUser|null;

Returns the resolved user for the current request, or null.

validate()¶

public function validate( array $credentials = [] ): bool;

Validates the given credentials without logging in.

Contracts\Auth\Guard\GuardConfig¶

Interface Source on GitHub

Authentication guard configuration contract.

Per-guard config shape is intentionally guard-specific (e.g. Token exposes getInputKey()/getStorageKey(); Session has no required config today). The contract carries no methods of its own - it only marks the type so AbstractGuard can accept any guard config uniformly.

Contracts\Auth\Guard\GuardStateful¶

Interface Source on GitHub

Implemented by guards backed by persistent state (sessions/cookies).

Uses Phalcon\Contracts\Auth\Adapter\Adapter · Phalcon\Contracts\Auth\AuthUser

Method Summary¶

Methods¶

attempt()¶

public function attempt(
    array $credentials = [],
    bool $remember = false
): bool;

Attempts to authenticate the user with the given credentials and, on success, persists the resulting state on the guard.

login()¶

public function login(
    AuthUser $user,
    bool $remember = false
): void;

loginById()¶

public function loginById(
    mixed $id,
    bool $remember = false
): false|AuthUser;

Logs in the user identified by $id. Returns the resolved user on success or false when no user matches the id.

logout()¶

public function logout(): void;

viaRemember()¶

public function viaRemember(): bool;

Contracts\Auth\Manager¶

Interface Source on GitHub

Uses Phalcon\Auth\Exception · Phalcon\Contracts\Auth\Access\Access · Phalcon\Contracts\Auth\Adapter\Adapter · Phalcon\Contracts\Auth\Guard\Guard

Method Summary¶

Methods¶

access()¶

public function access( string $accessName ): self;

Activates the named access gate for the current request and returns the manager for fluent only()/except() configuration.

Enforcement is opt-in and fail-open: when no access has been activated (getAccess() returns null) every dispatch is allowed. An activated gate stays active for subsequent dispatches in the same request (forwards, nested handlers) until it is replaced. Under classic FPM this is scoped to a single request; long-running runtimes must reset it per request.

addAccessList()¶

public function addAccessList( array $accessList ): self;

addGuard()¶

public function addGuard(
    string $nameGuard,
    Guard $guard,
    bool $isDefault = false
): self;

attempt()¶

public function attempt(
    array $credentials = [],
    bool $remember = false
): bool;

check()¶

public function check(): bool;

Whether the default guard reports the current request as authenticated.

except()¶

public function except( string $actions ): self;

Restricts the active access gate to skip the listed action names.

getAccess()¶

public function getAccess(): Access|null;

Returns the active access gate, or null when none has been activated - in which case listener enforcement is a no-op (see access()).

getAccessList()¶

public function getAccessList(): array;

getDefaultGuard()¶

public function getDefaultGuard(): Guard|null;

getGuards()¶

public function getGuards(): array;

guard()¶

public function guard( string $name = null ): Guard;

Returns the named guard, or the default guard when $name is null.

id()¶

public function id(): int|string|null;

Returns the authenticated user's identifier from the default guard, or null when no authenticated user is present.

logout()¶

public function logout(): void;

Logs the current user out via the default guard.

only()¶

public function only( string $actions ): self;

Restricts the active access gate to apply only to the listed action names.

setAccess()¶

public function setAccess( Access $access ): self;

setDefaultGuard()¶

public function setDefaultGuard( Guard $guard ): self;

user()¶

public function user(): AuthUser|null;

Returns the resolved user from the default guard, or null.

validate()¶

public function validate( array $credentials = [] ): bool;

Validates the given credentials against the default guard without logging in.

Contracts\Auth\RememberToken¶

Interface Source on GitHub

A persisted remember-me token row.

Method Summary¶

Methods¶

delete()¶

public function delete(): bool;

Deletes the token from storage.

getToken()¶

public function getToken(): string;

Returns the token value stored for this remember entry.

getUserAgent()¶

public function getUserAgent(): string|null;

Returns the user agent associated with this token, if any.

Contracts\Cache\Cache¶

Interface Source on GitHub

Canonical contract for Phalcon\Cache\Cache.

Uses DateInterval · Phalcon\Cache\Exception\InvalidArgumentException

Method Summary¶

Methods¶

clear()¶

public function clear(): bool;

Wipes clean the entire cache's keys.

delete()¶

public function delete( string $key ): bool;

Delete an item from the cache by its unique key.

deleteMultiple()¶

public function deleteMultiple( mixed $keys ): bool;

Deletes multiple cache items in a single operation.

get()¶

public function get(
    string $key,
    mixed $defaultValue = null
);

Fetches a value from the cache.

getMultiple()¶

public function getMultiple(
    mixed $keys,
    mixed $defaultValue = null
);

Obtains multiple cache items by their unique keys.

has()¶

public function has( string $key ): bool;

Determines whether an item is present in the cache.

set()¶

public function set(
    string $key,
    mixed $value,
    mixed $ttl = null
): bool;

Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.

setMultiple()¶

public function setMultiple(
    mixed $values,
    mixed $ttl = null
): bool;

Persists a set of key => value pairs in the cache, with an optional TTL.

Contracts\Cli\Dispatcher¶

Interface Source on GitHub

Canonical contract for Phalcon\Cli\Dispatcher.

Uses Phalcon\Cli\TaskInterface · Phalcon\Contracts\Dispatcher\Dispatcher

Method Summary¶

Methods¶

getActiveTask()¶

public function getActiveTask(): TaskInterface;

Returns the active task in the dispatcher

getLastTask()¶

public function getLastTask(): TaskInterface;

Returns the latest dispatched controller

getOptions()¶

public function getOptions(): array;

Get dispatched options

getTaskName()¶

public function getTaskName(): string;

Gets last dispatched task name

getTaskSuffix()¶

public function getTaskSuffix(): string;

Gets default task suffix

setDefaultTask()¶

public function setDefaultTask( string $taskName ): void;

Sets the default task name

setOptions()¶

public function setOptions( array $options ): void;

Set the options to be dispatched

setTaskName()¶

public function setTaskName( string $taskName ): void;

Sets the task name to be dispatched

setTaskSuffix()¶

public function setTaskSuffix( string $taskSuffix ): void;

Sets the default task suffix

Contracts\Container\Ioc\IocContainer¶

Interface Source on GitHub

[IocContainer][] affords obtaining services by name.

• Notes:

  • This interface does not afford service management. The container will need to obtain services somehow, e.g. from a [Service-Interop][] implementation.

Method Summary¶

Methods¶

getService()¶

public function getService( string $serviceName ): object;

Returns an instance of the $serviceName.

• Directives:

  • Implementations MUST throw [IocThrowable][] if the container cannot return an instance of the $serviceName.

• Notes:

  • The logic for this method is expressly unspecified. Retrieval may be accomplished via a service management subsystem, or by some other means.

  • The returned instance may be new or shared. The retrieval logic defines the service lifetime, not the container (per se) and not the caller requesting the service.

hasService()¶

public function hasService( string $serviceName ): bool;

Is the container able to return an instance of the $serviceName?

• Notes:

  • The logic for this method is expressly unspecified. The ability check may be accomplished by querying a service management subsystem, or by some other means.

Contracts\Container\Ioc\IocContainerFactory¶

Interface Source on GitHub

[IocContainerFactory][] affords obtaining a new instance of [IocContainer][].

Method Summary¶

Methods¶

newContainer()¶

public function newContainer(): IocContainer;

Returns a new instance of [IocContainer][].

• Notes:

  • Container instantiation logic is not specified. Implementations might use providers, configuration files, attribute or annotation collection, or some other means to create and populate a container. Implementations might also choose to return a compiled or otherwise reconstituted container.

Contracts\Container\Ioc\IocThrowable¶

Interface Source on GitHub

[IocThrowable][] extends [Throwable][] to mark an [Exception][] as IOC-related.

It adds no class members.

Uses Throwable

Contracts\Container\Ioc\IocTypeAliases¶

Interface Source on GitHub

Contracts\Container\Resolver\ReflectionMethodResolver¶

Interface Source on GitHub

Uses Phalcon\Contracts\Container\Ioc\IocContainer · ReflectionMethod

Method Summary¶

Methods¶

resolveMethod()¶

public function resolveMethod(
    IocContainer $ioc,
    ReflectionMethod $method,
    object $instance
): void;

Contracts\Container\Resolver\ReflectionParameterResolver¶

Interface Source on GitHub

Uses Phalcon\Contracts\Container\Ioc\IocContainer · ReflectionParameter

Method Summary¶

Methods¶

resolveParameter()¶

public function resolveParameter(
    IocContainer $ioc,
    ReflectionParameter $parameter
): mixed;

Contracts\Container\Resolver\Resolvable¶

Interface Source on GitHub

Uses Phalcon\Contracts\Container\Ioc\IocContainer

Method Summary¶

Methods¶

resolve()¶

public function resolve( IocContainer $ioc ): mixed;

Contracts\Container\Resolver\ResolverService¶

Interface Source on GitHub

Uses Phalcon\Contracts\Container\Ioc\IocContainer · ReflectionMethod · ReflectionParameter · ReflectionType

Method Summary¶

Methods¶

isResolvableClass()¶

public function isResolvableClass( string $className ): bool;

resolveCall()¶

public function resolveCall(
    IocContainer $ioc,
    callable $callableObject,
    array $arguments
): mixed;

resolveClass()¶

public function resolveClass(
    IocContainer $ioc,
    string $className,
    array $arguments
): object;

resolveMethod()¶

public function resolveMethod(
    IocContainer $ioc,
    ReflectionMethod $method,
    object $instance
): void;

resolveParameters()¶

public function resolveParameters(
    IocContainer $ioc,
    array $parameters,
    array $arguments
): array;

resolveType()¶

public function resolveType(
    IocContainer $ioc,
    ReflectionType $type
): mixed;

Contracts\Container\Resolver\ResolverThrowable¶

Interface Source on GitHub

Uses Throwable

Contracts\Container\Service\Collection¶

Interface Source on GitHub

Uses Closure · Phalcon\Container\Definition\ServiceDefinition · Phalcon\Container\Resolver\Resolver · Phalcon\Contracts\Container\Ioc\IocContainer

Method Summary¶

Methods¶

bind()¶

public function bind(
    string $interfaceName,
    string $concrete
): ServiceDefinition;

callableGet()¶

public function callableGet( string $name ): Closure;

callableNew()¶

public function callableNew( string $name ): Closure;

extend()¶

public function extend(
    string $name,
    callable $callableObject
): void;

get()¶

public function get( string $name ): mixed;

getAlias()¶

public function getAlias( string $name ): string;

getByTag()¶

public function getByTag( string $tag ): array;

getDefinition()¶

public function getDefinition( string $name ): ServiceDefinition;

getInstance()¶

public function getInstance( string $name ): object;

getParameter()¶

public function getParameter( string $name ): mixed;

getResolver()¶

public function getResolver(): Resolver;

has()¶

public function has( string $name ): bool;

hasAlias()¶

public function hasAlias( string $name ): bool;

hasDefinition()¶

public function hasDefinition( string $name ): bool;

hasInstance()¶

public function hasInstance( string $name ): bool;

hasParameter()¶

public function hasParameter( string $name ): bool;

isAutowireEnabled()¶

public function isAutowireEnabled(): bool;

new()¶

public function new( string $name ): mixed;

newDefinition()¶

public function newDefinition( string $name ): ServiceDefinition;

set()¶

public function set(
    string $name,
    mixed $definition
): ServiceDefinition;

setAlias()¶

public function setAlias(
    string $name,
    string $alias
): static;

setAutowire()¶

public function setAutowire( bool $enabled ): static;

setDefinition()¶

public function setDefinition(
    string $name,
    ServiceDefinition $definition
): static;

setInstance()¶

public function setInstance(
    string $name,
    object $instance,
    string $lifetime
): static;

setParameter()¶

public function setParameter(
    string $name,
    mixed $value
): static;

unsetAlias()¶

public function unsetAlias( string $name ): void;

unsetDefinition()¶

public function unsetDefinition( string $name ): void;

unsetInstance()¶

public function unsetInstance( string $name ): void;

unsetInstances()¶

public function unsetInstances( string $lifetime ): void;

unsetParameter()¶

public function unsetParameter( string $name ): void;

Contracts\Container\Service\Definition¶

Interface Source on GitHub

Uses Phalcon\Contracts\Container\Ioc\IocContainer

Method Summary¶

Methods¶

addExtender()¶

public function addExtender( callable $extender ): static;

buildService()¶

public function buildService( IocContainer $ioc ): object;

getClass()¶

public function getClass(): string;

getExtenders()¶

public function getExtenders(): array;

getFactory()¶

public function getFactory(): callable;

getLifetime()¶

public function getLifetime(): string;

getServiceName()¶

public function getServiceName(): string;

hasClass()¶

public function hasClass(): bool;

hasExtenders()¶

public function hasExtenders(): bool;

hasFactory()¶

public function hasFactory(): bool;

setClass()¶

public function setClass( string $className ): static;

setExtenders()¶

public function setExtenders( array $extenders ): static;

setFactory()¶

public function setFactory( callable $factory ): static;

setLifetime()¶

public function setLifetime( string $lifetime ): static;

unsetClass()¶

public function unsetClass(): static;

unsetExtenders()¶

public function unsetExtenders(): static;

unsetFactory()¶

public function unsetFactory(): static;

Contracts\Container\Service\Provider¶

Interface Source on GitHub

Method Summary¶

Methods¶

provide()¶

public function provide( Collection $services ): void;

Contracts\Container\Service\Throwable¶

Interface Source on GitHub

Uses Throwable

Contracts\Db\Adapter\Adapter¶

Interface Source on GitHub

Canonical contract for Phalcon\Db adapters.

@todo v7 - these will become required interface members. They are omitted from the v5 line to avoid breaking third-party implementors: - addCheck() : bool - createMaterializedView() : bool - dropCheck() : bool - dropMaterializedView() : bool - onConflictUpdate() : string - refreshMaterializedView() : bool - returning() : string

Uses Phalcon\Db\ColumnInterface · Phalcon\Db\DialectInterface · Phalcon\Db\IndexInterface · Phalcon\Db\RawValue · Phalcon\Db\ReferenceInterface · Phalcon\Db\ResultInterface

Method Summary¶

Methods¶

addColumn()¶

public function addColumn(
    string $tableName,
    string $schemaName,
    ColumnInterface $column
): bool;

Adds a column to a table

addForeignKey()¶

public function addForeignKey(
    string $tableName,
    string $schemaName,
    ReferenceInterface $reference
): bool;

Adds a foreign key to a table

addIndex()¶

public function addIndex(
    string $tableName,
    string $schemaName,
    IndexInterface $index
): bool;

Adds an index to a table

addPrimaryKey()¶

public function addPrimaryKey(
    string $tableName,
    string $schemaName,
    IndexInterface $index
): bool;

Adds a primary key to a table

affectedRows()¶

public function affectedRows(): int;

Returns the number of affected rows by the last INSERT/UPDATE/DELETE reported by the database system

begin()¶

public function begin( bool $nesting = true ): bool;

Starts a transaction in the connection

close()¶

public function close(): void;

Closes active connection returning success. Phalcon automatically closes and destroys active connections within Phalcon\Db\Pool

commit()¶

public function commit( bool $nesting = true ): bool;

Commits the active transaction in the connection

connect()¶

public function connect( array $descriptor = [] ): void;

This method is automatically called in \Phalcon\Db\Adapter\Pdo constructor. Call it when you need to restore a database connection

createSavepoint()¶

public function createSavepoint( string $name ): bool;

Creates a new savepoint

createTable()¶

public function createTable(
    string $tableName,
    string $schemaName,
    array $definition
): bool;

Creates a table

createView()¶

public function createView(
    string $viewName,
    array $definition,
    string $schemaName = null
): bool;

Creates a view

delete()¶

public function delete(
    mixed $table,
    string $whereCondition = null,
    array $placeholders = [],
    array $dataTypes = []
): bool;

Deletes data from a table using custom RDBMS SQL syntax

describeColumns()¶

public function describeColumns(
    string $table,
    string $schema = null
): ColumnInterface[];

Returns an array of Phalcon\Db\Column objects describing a table

describeIndexes()¶

public function describeIndexes(
    string $table,
    string $schema = null
): IndexInterface[];

Lists table indexes

describeReferences()¶

public function describeReferences(
    string $table,
    string $schema = null
): ReferenceInterface[];

Lists table references

dropColumn()¶

public function dropColumn(
    string $tableName,
    string $schemaName,
    string $columnName
): bool;

Drops a column from a table

dropForeignKey()¶

public function dropForeignKey(
    string $tableName,
    string $schemaName,
    string $referenceName
): bool;

Drops a foreign key from a table

dropIndex()¶

public function dropIndex(
    string $tableName,
    string $schemaName,
    string $indexName
): bool;

Drop an index from a table

dropPrimaryKey()¶

public function dropPrimaryKey(
    string $tableName,
    string $schemaName
): bool;

Drops primary key from a table

dropTable()¶

public function dropTable(
    string $tableName,
    string $schemaName = null,
    bool $ifExists = true
): bool;

Drops a table from a schema/database

dropView()¶

public function dropView(
    string $viewName,
    string $schemaName = null,
    bool $ifExists = true
): bool;

Drops a view

escapeIdentifier()¶

public function escapeIdentifier( mixed $identifier ): string;

Escapes a column/table/schema name

escapeString()¶

public function escapeString( string $str ): string;

Escapes a value to avoid SQL injections

execute()¶

public function execute(
    string $sqlStatement,
    array $bindParams = [],
    array $bindTypes = []
): bool;

Sends SQL statements to the database server returning the success state. Use this method only when the SQL statement sent to the server does not return any rows

fetchAll()¶

public function fetchAll(
    string $sqlQuery,
    int $fetchMode = 2,
    array $bindParams = [],
    array $bindTypes = []
): array;

Dumps the complete result of a query into an array

fetchColumn()¶

public function fetchColumn(
    string $sqlQuery,
    array $placeholders = [],
    mixed $column = 0
): string|bool;

Returns the n'th field of first row in a SQL query result

// Getting count of robots
$robotsCount = $connection->fetchColumn("SELECT COUNT(*) FROM robots");
print_r($robotsCount);

// Getting name of last edited robot
$robot = $connection->fetchColumn(
    "SELECT id, name FROM robots ORDER BY modified DESC",
    1
);
print_r($robot);

fetchOne()¶

public function fetchOne(
    string $sqlQuery,
    int $fetchMode = 2,
    array $bindParams = [],
    array $bindTypes = []
): array;

Returns the first row in a SQL query result

forUpdate()¶

public function forUpdate(
    string $sqlQuery,
    string $modifier = ""
): string;

Returns a SQL modified with a FOR UPDATE clause. The optional modifier appends a row-lock disposition keyword - pass Dialect::LOCK_NOWAIT or Dialect::LOCK_SKIP_LOCKED (or leave as Dialect::LOCK_NONE).

getColumnDefinition()¶

public function getColumnDefinition( ColumnInterface $column ): string;

Returns the SQL column definition from a column

getColumnList()¶

public function getColumnList( mixed $columnList ): string;

Gets a list of columns

getConnectionId()¶

public function getConnectionId(): int;

Gets the active connection unique identifier

getDefaultIdValue()¶

public function getDefaultIdValue(): RawValue;

Return the default identity value to insert in an identity column

getDefaultValue()¶

public function getDefaultValue(): RawValue|null;

Returns the default value to make the RBDM use the default value declared in the table definition

// Inserting a new robot with a valid default value for the column 'year'
$success = $connection->insert(
    "robots",
    [
        "Astro Boy",
        $connection->getDefaultValue()
    ],
    [
        "name",
        "year",
    ]
);

@todo Return NULL if this is not supported by the adapter

getDescriptor()¶

public function getDescriptor(): array;

Return descriptor used to connect to the active database

getDialect()¶

public function getDialect(): DialectInterface;

Returns internal dialect instance

getDialectType()¶

public function getDialectType(): string;

Returns the name of the dialect used

getInternalHandler()¶

public function getInternalHandler(): mixed;

Return internal PDO handler

getNestedTransactionSavepointName()¶

public function getNestedTransactionSavepointName(): string;

Returns the savepoint name to use for nested transactions

getRealSQLStatement()¶

public function getRealSQLStatement(): string;

Active SQL statement in the object without replace bound parameters

getSQLBindTypes()¶

public function getSQLBindTypes(): array;

Active SQL statement in the object

getSQLStatement()¶

public function getSQLStatement(): string;

Active SQL statement in the object

getSQLVariables()¶

public function getSQLVariables(): array;

Active SQL statement in the object

getType()¶

public function getType(): string;

Returns type of database system the adapter is used for

insert()¶

public function insert(
    string $table,
    array $values,
    mixed $fields = null,
    mixed $dataTypes = null
): bool;

Inserts data into a table using custom RDBMS SQL syntax

insertAsDict()¶

public function insertAsDict(
    string $table,
    mixed $data,
    mixed $dataTypes = null
): bool;

Inserts data into a table using custom RBDM SQL syntax

// Inserting a new robot
$success = $connection->insertAsDict(
    "robots",
    [
        "name" => "Astro Boy",
        "year" => 1952,
    ]
);

// Next SQL sentence is sent to the database system
INSERT INTO `robots` (`name`, `year`) VALUES ("Astro boy", 1952);

isNestedTransactionsWithSavepoints()¶

public function isNestedTransactionsWithSavepoints(): bool;

Returns if nested transactions should use savepoints

isUnderTransaction()¶

public function isUnderTransaction(): bool;

Checks whether connection is under database transaction

lastInsertId()¶

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

Returns insert id for the auto_increment column inserted in the last SQL statement

limit()¶

public function limit(
    string $sqlQuery,
    mixed $number
): string;

Appends a LIMIT clause to sqlQuery argument

listTables()¶

public function listTables( string $schemaName = null ): array;

List all tables on a database

listViews()¶

public function listViews( string $schemaName = null ): array;

List all views on a database

modifyColumn()¶

public function modifyColumn(
    string $tableName,
    string $schemaName,
    ColumnInterface $column,
    ColumnInterface $currentColumn = null
): bool;

Modifies a table column based on a definition

query()¶

public function query(
    string $sqlStatement,
    array $bindParams = [],
    array $bindTypes = []
): ResultInterface|bool;

Sends SQL statements to the database server returning the success state. Use this method only when the SQL statement sent to the server returns rows

releaseSavepoint()¶

public function releaseSavepoint( string $name ): bool;

Releases given savepoint

rollback()¶

public function rollback( bool $nesting = true ): bool;

Rollbacks the active transaction in the connection

rollbackSavepoint()¶

public function rollbackSavepoint( string $name ): bool;

Rollbacks given savepoint

setNestedTransactionsWithSavepoints()¶

public function setNestedTransactionsWithSavepoints( bool $nestedTransactionsWithSavepoints ): \Phalcon\Db\Adapter\AdapterInterface;

Set if nested transactions should use savepoints

sharedLock()¶

public function sharedLock(
    string $sqlQuery,
    string $modifier = ""
): string;

Returns a SQL modified with a shared-lock clause. See the dialect's sharedLock() for per-engine semantics. The optional modifier is passed straight through (use Dialect::LOCK_NOWAIT / Dialect::LOCK_SKIP_LOCKED for PostgreSQL).

supportSequences()¶

public function supportSequences(): bool;

Check whether the database system requires a sequence to produce auto-numeric values

supportsDefaultValue()¶

public function supportsDefaultValue(): bool;

SQLite does not support the DEFAULT keyword

tableExists()¶

public function tableExists(
    string $tableName,
    string $schemaName = null
): bool;

Generates SQL checking for the existence of a schema.table

tableOptions()¶

public function tableOptions(
    string $tableName,
    string $schemaName = null
): array;

Gets creation options from a table

update()¶

public function update(
    string $table,
    mixed $fields,
    mixed $values,
    mixed $whereCondition = null,
    mixed $dataTypes = null
): bool;

Updates data on a table using custom RDBMS SQL syntax

updateAsDict()¶

public function updateAsDict(
    string $table,
    mixed $data,
    mixed $whereCondition = null,
    mixed $dataTypes = null
): bool;

Updates data on a table using custom RBDM SQL syntax Another, more convenient syntax

// Updating existing robot
$success = $connection->updateAsDict(
    "robots",
    [
        "name" => "New Astro Boy",
    ],
    "id = 101"
);

// Next SQL sentence is sent to the database system
UPDATE `robots` SET `name` = "Astro boy" WHERE id = 101

useExplicitIdValue()¶

public function useExplicitIdValue(): bool;

Check whether the database system requires an explicit value for identity columns

viewExists()¶

public function viewExists(
    string $viewName,
    string $schemaName = null
): bool;

Generates SQL checking for the existence of a schema.view

Contracts\Db\Check¶

Interface Source on GitHub

Canonical contract for Phalcon\Db\Check.

Method Summary¶

Methods¶

getExpression()¶

public function getExpression(): string;

Gets the CHECK expression (the SQL boolean predicate).

getName()¶

public function getName(): string;

Gets the constraint name. An empty string indicates an unnamed CHECK constraint - the dialect will emit the clause without a CONSTRAINT prefix in that case.

Contracts\Db\Column¶

Interface Source on GitHub

Canonical contract for Phalcon\Db\Column.

@todo v7 - these will become required interface members. They are omitted from the v5 line to avoid breaking third-party implementors: - getGenerationExpression() : string | null - isArray() : bool - isGenerated() : bool - isGenerationStored() : bool - isInvisible() : bool

Method Summary¶

Methods¶

getAfterPosition()¶

public function getAfterPosition(): string|null;

Check whether field absolute to position in table

getBindType()¶

public function getBindType(): int;

Returns the type of bind handling

getDefault()¶

public function getDefault(): mixed;

Returns default value of column

getName()¶

public function getName(): string;

Returns column name

getScale()¶

public function getScale(): int;

Returns column scale

getSize()¶

public function getSize(): int|string;

Returns column size

getType()¶

public function getType(): int|string;

Returns column type

getTypeReference()¶

public function getTypeReference(): int;

Returns column type reference

getTypeValues()¶

public function getTypeValues(): array|string|int;

Returns column type values

hasDefault()¶

public function hasDefault(): bool;

Check whether column has default value

isAutoIncrement()¶

public function isAutoIncrement(): bool;

Auto-Increment

isFirst()¶

public function isFirst(): bool;

Check whether column have first position in table

isNotNull()¶

public function isNotNull(): bool;

Not null

isNumeric()¶

public function isNumeric(): bool;

Check whether column have an numeric type

isPrimary()¶

public function isPrimary(): bool;

Column is part of the primary key?

isUnsigned()¶

public function isUnsigned(): bool;

Returns true if number column is unsigned

Contracts\Db\Dialect¶

Interface Source on GitHub

Canonical contract for Phalcon\Db dialects.

@todo v7 - these will become required interface members. They are omitted from the v5 line to avoid breaking third-party implementors: - addCheck() : string - createMaterializedView() : string - dropCheck() : string - dropMaterializedView() : string - onConflictUpdate() : string - refreshMaterializedView() : string - returning() : string

Uses Phalcon\Db\ColumnInterface · Phalcon\Db\IndexInterface · Phalcon\Db\ReferenceInterface

Method Summary¶