Yiisoft\Db\Oracle\Dsn

Complexity

Total Complexity

5

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	1	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	asString()	0	19	4

<?php

declare(strict_types=1);

namespace Yiisoft\Db\Oracle;

use Yiisoft\Db\Connection\AbstractDsn;

/**
 * Implement a Data Source Name (DSN) for an Oracle Server.
 *
 * @link https://www.php.net/manual/en/ref.pdo-oci.connection.php
 */
final class Dsn extends AbstractDsn
{
    /**
     * @psalm-param string[] $options
     */
    public function __construct(
        private string $driver,
        private string $host,
        private string|null $databaseName = null,
        private string $port = '1521',
        private array $options = []
    ) {
        parent::__construct($driver, $host, $databaseName, $port, $options);
    }

    /**
     * @return string The Data Source Name, or DSN, contains the information required to connect to the database.
     *
     * Please refer to the [PHP manual](https://php.net/manual/en/pdo.construct.php) on the format of the DSN string.
     *
     * The `driver` array key is used as the driver prefix of the DSN, all further key-value pairs are rendered as
     * `key=value` and concatenated by `;`. For example:
     *
     * ```php
     * $dsn = new Dsn('oci', 'localhost', 'yiitest', '1521', ['charset' => 'AL32UTF8']);
     * $connection = new Connection($dsn->asString(), 'system', 'root');
     * ```
     *
     * Will result in the DSN string `oci:dbname=localhost:1521/yiitest;charset=AL32UTF8`.
     */
    public function asString(): string
    {
        if (!empty($this->databaseName)) {
            $dsn = "$this->driver:" . "dbname=$this->host:$this->port/$this->databaseName";
        } else {
            $dsn = "$this->driver:" . "dbname=$this->host:$this->port";
        }

        $parts = [];

        foreach ($this->options as $key => $value) {
            $parts[] = "$key=$value";
        }

        if (!empty($parts)) {
            $dsn .= ';' . implode(';', $parts);
        }

        return $dsn;
    }
}