Documentation

PdbConfig extends Collection

in package

• karmabunny
• pdb

The configuration for a Pdb object.

Table of Contents

Constants

HACK_MYSQL_TZ_NO_SESSION  : mixed = 'mysql_tz_no_session'

Don't set the session TZ, for when the MySQL has no TZ data.

HACK_MYSQL_TZ_OFFSET  : mixed = 'mysql_tz_offset'

If MySQL hasn't got TZ data installed, convert any IANA zone names to an offset.

HACK_NO_ENGINE_SUBSTITUTION  : mixed = 'no_engine_substitution'

HACK_SQLITE_FUNCTIONS  : mixed = 'sqlite_functions'

Insert some custom functions.

HACK_TIME_ZONE  : mixed = 'time_zone'

TX_ENABLE_NESTED  : mixed = 0x4

Enable nested transaction (via savepoints).

TX_FORCE_COMMIT_KEYS  : mixed = 0x8

Force the user to provide a transaction key when calling `commit()`.

TX_STRICT_COMMIT  : mixed = 0x1

Require an active transaction when calling `commit()`.

TX_STRICT_ROLLBACK  : mixed = 0x2

Require an active transaction when calling `rollback()`.

TYPE_MSSQL  : mixed = 'mssql'

TYPE_MYSQL  : mixed = 'mysql'

TYPE_ORACLE  : mixed = 'oracle'

TYPE_PGSQL  : mixed = 'pgsql'

TYPE_SQLITE  : mixed = 'sqlite'

Properties

$_pdo  : PDO|null

This is used in the Sprout compatibility layer.

$attributes  : array<string|int, mixed>

Connection attributes.

$cache  : PdbCache|string|array<string|int, mixed>

A caching class extending PdbCache.

$character_set  : string

Connection charset, default utf8.

$collation  : string

Default collation, default utf8.

$database  : string

Database name.

$dsn  : string|null

Connection string override.

$formatters  : array<string|int, callable|PdbDataFormatterInterface|string>

String formatters for class parameters.

$hacks  : array<string|int, string>

Driver specific hacks.

$host  : string

Connection hostname or IP address.

$identity  : string|null

An identity key for this connection.

$inflector  : InflectorInterface|string|array<string|int, mixed>

An inflector config for pluralisation and such.

$namespace  : string

Namespace for UUIDv5 generation.

$pass  : string

Connection password.

$port  : int|null

Port number, or null for default.

$prefix  : string

Global table prefix.

$schema  : string

Database schema, for Postgres.

$session  : array<string|int, mixed>

Session variables per call to `connect()`.

$socket  : string|bool

Treat the host as a unix socket for MySQL connections.

$sslmode  : string

Secure mode, for Postgres.

$table_prefixes  : array<string, string>

Per-table prefixes.

$timeout  : int

Connection timeout.

$timezone  : string|null

Set the timezone for this connection.

$transaction_mode  : int

TX enum

$ttl  : int

Default caching TTL, in seconds.

$type  : string

One of the TYPE enum.

$use_system_timezone  : bool

Use the PHP timezone for `Pdb::now()`.

$user  : string

Connection username.

$_checksums  : DirtyChecksums|null

Methods

__construct()  : mixed

__serialize()  : array<string|int, mixed>

__unserialize()  : void

extraFields()  : array<string|int, callable>

Define extra fields that you _might_ want included in the `toArray()` output.

fields()  : array<string|int, callable|bool>

These are fields for use in `toArray()`.

getChecksums()  : DirtyChecksums

Get a checksums store for this object.

getDsn()  : string

The 'Data Source Name' used to connect to the database.

getFieldQuotes()  : array<string|int, string>

Get parameter quotes as appropriate for the underlying DBMS.

getHack()  : mixed

Is this hack enabled?

getHacks()  : array<string|int, mixed>

The hacks applied to this configuration.

getIdentity()  : string

The identity key for this config.

getIterator()  : Traversable

getPrefixes()  : array<string|int, string>

Get prefixing rules.

jsonSerialize()  : mixed

offsetExists()  : bool

offsetGet()  : mixed

offsetSet()  : void

offsetUnset()  : void

toArray()  : array<string|int, mixed>

Convert this object to an array.

update()  : void

getSerializedProperties()  : array<string|int, mixed>

Get an array of properties to serialize.

$config->cache = [
   PdbRedisCache::class => [
      'host' => 'localhost',
      'prefix' => 'pdb:',
   ],
];

$formatter = function($date) {
    return date('Y-m-d H:i:s', $date);
}
$config->formatters[DateTimeInterface::class] = $formatter;

// Inheriting fields from the parent:
$fields = parent::fields();
$fields['hide_this_field'] = false;
unset($fields['this_also_works']);
return $fields;

// Declaring explicit fields, ignoring inherited:
return [
  'real_field' => true,
  'and_this_field' => true,
];

// Adding virtual fields:
$fields = parent::fields();
$fields['virtual_thing'] = [$this, 'getMyVirtualThing'];
$fields['inline_thing'] = function() {
   return 'hey look: ' . time();
};
return $fields;