cycle / database

src/Config/DriverConfig.php

<?php

/**
 * This file is part of Cycle Database package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Cycle\Database\Config;

use Cycle\Database\Driver\DriverInterface;

/**
 * Connection configuration described in DBAL config file. Any driver can be
 * used as data source for multiple databases as table prefix and quotation
 * defined on Database instance level.
 *
 * @template T of PDOConnectionConfig
 */
abstract class DriverConfig
{
    use RestoreStateTrait;

    public array $options = [];
    protected array $defaultOptions = [
        'withDatetimeMicroseconds' => false,
        'logInterpolatedQueries' => false,
        'logQueryParameters' => false,
    ];

    /**
     * @param T $connection
     * @param class-string<DriverInterface> $driver

The doc comment class-string<DriverInterface> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<DriverInterface>.

     * @param bool $reconnect Allow reconnects
     * @param non-empty-string $timezone All datetime objects will be converted
     *        relative to this timezone (must match with DB timezone!)
     * @param bool $queryCache Enables query caching
     * @param bool $readonlySchema Disable schema modifications
     * @param bool $readonly Disable write expressions
     * @param array{
     *     withDatetimeMicroseconds?: bool,
     *     logInterpolatedQueries?: bool,
     *     logQueryParameters?: bool
     * } $options
     */
    public function __construct(
        public ConnectionConfig $connection,
        public string $driver,
        public bool $reconnect = true,
        public string $timezone = 'UTC',
        public bool $queryCache = true,
        public bool $readonlySchema = false,
        public bool $readonly = false,
        array $options = [],
    ) {
        $this->options = $options + $this->defaultOptions;
    }
}