AdapterInterface.php

<?php

declare(strict_types=1);

namespace PhpDb\Adapter;

use PhpDb\ResultSet;

/**
 * @property Driver\DriverInterface $driver
 * @property Platform\PlatformInterface $platform
 */
interface AdapterInterface
{
    /**
     * Query Mode Constants
     */
    public const QUERY_MODE_EXECUTE = 'execute';
    public const QUERY_MODE_PREPARE = 'prepare';

    /**
     * Prepare Type Constants
     */
    public const PREPARE_TYPE_POSITIONAL = 'positional';
    public const PREPARE_TYPE_NAMED      = 'named';

    public const FUNCTION_FORMAT_PARAMETER_NAME = 'formatParameterName';
    public const FUNCTION_QUOTE_IDENTIFIER      = 'quoteIdentifier';
    public const FUNCTION_QUOTE_VALUE           = 'quoteValue';

    public const VALUE_QUOTE_SEPARATOR = 'quoteSeparator';

    public function withProfiler(Profiler\ProfilerInterface $profiler): AdapterInterface;

    public function getDriver(): Driver\DriverInterface;

    public function getPlatform(): Platform\PlatformInterface;

    public function getProfiler(): ?Profiler\ProfilerInterface;

    public function getQueryResultSetPrototype(): ResultSet\ResultSetInterface;

    public function createStatement(
        ?string $initialSql = null,
        ParameterContainer|array $initialParameters = []
    ): Driver\StatementInterface;

    public function query(
        string $sql,
        ParameterContainer|array|string $parametersOrQueryMode = self::QUERY_MODE_PREPARE,
        ?ResultSet\ResultSetInterface $resultPrototype = null
    ): Driver\StatementInterface|ResultSet\ResultSetInterface|Driver\ResultInterface;

    /**
     * @todo 0.3.x track down this usage!!!
     * @return array
     */
    public function getHelpers();
}