DbConfig

Type
Class
Namespace
craft\config
Inherits
craft\config\DbConfig » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0.0

DB config class

View source

Public Properties

PropertyDescription
attributesarray – An array of key => value pairs of PDO attributes to pass into the PDO constructor.
charsetstring – The charset to use when creating tables.
databasestring – The name of the database to select.
driverstring – The database driver to use.
dsnstring – If you want to manually specify your PDO DSN connection string you can do so here.
passwordstring – The database password to connect with.
portinteger – The database server port.
schemastring – The schema that Postgres is configured to use by default (PostgreSQL only).
serverstring – The database server name or IP address.
tablePrefixstring – If you're sharing Craft installs in a single database (MySQL) or a single database and using a shared schema (PostgreSQL), then you can set a table prefix here to avoid table naming conflicts per install.
unixSocketstring, null – MySQL only.
urlstring, null – The database connection URL, if one was provided by your hosting environment.
userstring – The database username to connect with.

attributes

Type
array

An array of key => value pairs of PDO attributes to pass into the PDO constructor.

For example, when using the MySQL PDO driver (http://php.net/manual/en/ref.pdo-mysql.php), if you wanted to enable a SSL database connection (assuming SSL is enabled in MySQL (https://dev.mysql.com/doc/refman/5.5/en/using-secure-connections.html) and 'user' can connect via SSL, you'd set these:

[
    PDO::MYSQL_ATTR_SSL_KEY    => '/path/to/my/client-key.pem',
    PDO::MYSQL_ATTR_SSL_CERT   => '/path/to/my/client-cert.pem',
    PDO::MYSQL_ATTR_SSL_CA     => '/path/to/my/ca-cert.pem',
],

View source

charset

Type
string

The charset to use when creating tables.

View source

database

Type
string

The name of the database to select.

View source

driver

Type
string

The database driver to use. Either 'mysql' for MySQL or 'pgsql' for PostgreSQL.

View source

dsn

Type
string

If you want to manually specify your PDO DSN connection string you can do so here.

  • MySQL: http://php.net/manual/en/ref.pdo-mysql.connection.php
  • PostgreSQL: http://php.net/manual/en/ref.pdo-pgsql.connection.php If you set this, then the server, port, user, password, database, driver and unixSocket config settings will be ignored.

View source

password

Type
string

The database password to connect with.

View source

port

Type
integer

The database server port. Defaults to 3306 for MySQL and 5432 for PostgreSQL.

View source

schema

Type
string

The schema that Postgres is configured to use by default (PostgreSQL only).

See also https://www.postgresql.org/docs/8.2/static/ddl-schemas.html

View source

server

Type
string

The database server name or IP address. Usually 'localhost' or '127.0.0.1'.

View source

tablePrefix

Type
string

If you're sharing Craft installs in a single database (MySQL) or a single database and using a shared schema (PostgreSQL), then you can set a table prefix here to avoid table naming conflicts per install. This can be no more than 5 characters, and must be all lowercase.

View source

unixSocket

Type
string, null

MySQL only. If this is set, then the CLI connection string (used for yiic) will connect to the Unix socket, instead of the server and port. If this is specified, then 'server' and 'port' settings are ignored.

View source

url

Type
string, null

The database connection URL, if one was provided by your hosting environment.

If this is set, the values for driver, user, database, server, port, and database will be extracted from it.

View source

user

Type
string

The database username to connect with.

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
updateDsn()Updates the DSN string based on the config setting values.

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

updateDsn()

Updates the DSN string based on the config setting values.

View source

Constants

ConstantDescription
DRIVER_MYSQL
DRIVER_PGSQL