0 follower

Abstract Class Yiisoft\Db\Driver\Pdo\AbstractPdoDriver

All Classes | Properties | Methods

Inheritance	Yiisoft\Db\Driver\Pdo\AbstractPdoDriver
Implements	Yiisoft\Db\Driver\Pdo\PdoDriverInterface

Serves as the base class for creating PDO (PHP Data Objects) drivers.

It provides a set of common methods and properties that are implemented by the specific PDO driver classes, such as MSSQL, Mysql, MariaDb, Oracle, PostgreSQL, and SQLite.

Protected Properties

Hide inherited properties

Property	Type	Defined By
$attributes	array	Yiisoft\Db\Driver\Pdo\AbstractPdoDriver
$charset	string\|null	Yiisoft\Db\Driver\Pdo\AbstractPdoDriver
$dsn	string	Yiisoft\Db\Driver\Pdo\AbstractPdoDriver
$password	string	Yiisoft\Db\Driver\Pdo\AbstractPdoDriver
$username	string	Yiisoft\Db\Driver\Pdo\AbstractPdoDriver

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()		Yiisoft\Db\Driver\Pdo\AbstractPdoDriver
attributes()		Yiisoft\Db\Driver\Pdo\AbstractPdoDriver
charset()		Yiisoft\Db\Driver\Pdo\AbstractPdoDriver
createConnection()		Yiisoft\Db\Driver\Pdo\AbstractPdoDriver
getCharset()		Yiisoft\Db\Driver\Pdo\AbstractPdoDriver
getDriverName()		Yiisoft\Db\Driver\Pdo\PdoDriverInterface
getDsn()		Yiisoft\Db\Driver\Pdo\AbstractPdoDriver
getPassword()		Yiisoft\Db\Driver\Pdo\AbstractPdoDriver
getUsername()		Yiisoft\Db\Driver\Pdo\AbstractPdoDriver
password()		Yiisoft\Db\Driver\Pdo\AbstractPdoDriver
username()		Yiisoft\Db\Driver\Pdo\AbstractPdoDriver

Property Details

Hide inherited properties

$attributes protected property

protected array $attributes = []

$charset protected property

protected string|null $charset = null

$dsn protected property

protected string $dsn = null

$password protected property

protected string $password = ''

$username protected property

protected string $username = ''

Method Details

Hide inherited methods

__construct() public method

public __construct( string\|\Stringable $dsn, string $username = '', string $password = '', array $attributes = [] ): mixed
$dsn	string\|\Stringable
$username	string
$password	string
$attributes	array

Source code

                public function __construct(
    string|Stringable $dsn,
    protected string $username = '',
    #[SensitiveParameter]
    protected string $password = '',
    protected array $attributes = [],
) {
    $this->dsn = (string) $dsn;
}

attributes() public method

public attributes( array $attributes ): void
$attributes	array

Source code

                public function attributes(array $attributes): void
{
    $this->attributes = $attributes;
}

charset() public method

public charset( string\|null $charset ): void
$charset	string\|null

Source code

                public function charset(?string $charset): void
{
    $this->charset = $charset;
}

createConnection() public method

public createConnection( ): PDO

Source code

                public function createConnection(): PDO
{
    return new PDO($this->dsn, $this->username, $this->password, $this->attributes);
}

getCharset() public method

public getCharset( ): string\|null

Source code

                public function getCharset(): ?string
{
    return $this->charset;
}

getDriverName() public abstract method

Defined in: Yiisoft\Db\Driver\Pdo\PdoDriverInterface::getDriverName()

public abstract getDriverName( ): string
return	string	The driver name for DB connection.

Source code

                public function getDriverName(): string;

getDsn() public method

public getDsn( ): string

Source code

                public function getDsn(): string
{
    return $this->dsn;
}

getPassword() public method

public getPassword( ): string

Source code

                public function getPassword(): string
{
    return $this->password;
}

getUsername() public method

public getUsername( ): string

Source code

                public function getUsername(): string
{
    return $this->username;
}

password() public method

public password( string $password ): void
$password	string

Source code

                public function password(#[SensitiveParameter] string $password): void
{
    $this->password = $password;
}

username() public method

public username( string $username ): void
$username	string

Source code

                public function username(string $username): void
{
    $this->username = $username;
}