StubConnection.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\Core\Database\Stub;

use Drupal\Core\Database\Connection;
use Drupal\Core\Database\ExceptionHandler;
use Drupal\Core\Database\Log;
use Drupal\Core\Database\Query\Delete;
use Drupal\Core\Database\Query\Insert;
use Drupal\Core\Database\Query\Merge;
use Drupal\Core\Database\Query\Select;
use Drupal\Core\Database\Query\Truncate;
use Drupal\Core\Database\Query\Update;
use Drupal\Core\Database\StatementWrapper;
use Drupal\Core\Database\Transaction;
use Drupal\Tests\Core\Database\Stub\Driver\Schema;

/**
 * A stub of the abstract Connection class for testing purposes.
 *
 * Includes minimal implementations of Connection's abstract methods.
 */
class StubConnection extends Connection {
    
    /**
     * {@inheritdoc}
     */
    protected $statementWrapperClass = StatementWrapper::class;
    
    /**
     * Public property so we can test driver loading mechanism.
     *
     * @var string
     * @see driver().
     */
    public $driver = 'stub';
    
    /**
     * Constructs a Connection object.
     *
     * @param \PDO $connection
     *   An object of the PDO class representing a database connection.
     * @param array $connection_options
     *   An array of options for the connection.
     * @param string[]|null $identifier_quotes
     *   The identifier quote characters. Defaults to an empty strings.
     */
    public function __construct(\PDO $connection, array $connection_options, $identifier_quotes = [
        '',
        '',
    ]) {
        $this->identifierQuotes = $identifier_quotes;
        parent::__construct($connection, $connection_options);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function open(array &$connection_options = []) {
        return new \stdClass();
    }
    
    /**
     * {@inheritdoc}
     */
    public function queryRange($query, $from, $count, array $args = [], array $options = []) {
        return NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function driver() {
        return $this->driver;
    }
    
    /**
     * {@inheritdoc}
     */
    public function databaseType() {
        return 'stub';
    }
    
    /**
     * {@inheritdoc}
     */
    public function createDatabase($database) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function mapConditionOperator($operator) {
        return NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function nextId($existing_id = 0) {
        @trigger_error('Drupal\\Core\\Database\\Connection::nextId() is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. Modules should use instead the keyvalue storage for the last used id. See https://www.drupal.org/node/3349345', E_USER_DEPRECATED);
        return 0;
    }
    
    /**
     * Helper method to test database classes are not included in backtraces.
     *
     * @return array
     *   The caller stack entry.
     */
    public function testLogCaller() {
        return (new Log())->findCaller();
    }
    
    /**
     * {@inheritdoc}
     */
    public function exceptionHandler() {
        return new ExceptionHandler();
    }
    
    /**
     * {@inheritdoc}
     */
    public function select($table, $alias = NULL, array $options = []) {
        return new Select($this, $table, $alias, $options);
    }
    
    /**
     * {@inheritdoc}
     */
    public function insert($table, array $options = []) {
        return new Insert($this, $table, $options);
    }
    
    /**
     * {@inheritdoc}
     */
    public function merge($table, array $options = []) {
        return new Merge($this, $table, $options);
    }
    
    /**
     * {@inheritdoc}
     */
    public function upsert($table, array $options = []) {
        return new StubUpsert($this, $table, $options);
    }
    
    /**
     * {@inheritdoc}
     */
    public function update($table, array $options = []) {
        return new Update($this, $table, $options);
    }
    
    /**
     * {@inheritdoc}
     */
    public function delete($table, array $options = []) {
        return new Delete($this, $table, $options);
    }
    
    /**
     * {@inheritdoc}
     */
    public function truncate($table, array $options = []) {
        return new Truncate($this, $table, $options);
    }
    
    /**
     * {@inheritdoc}
     */
    public function schema() {
        if (empty($this->schema)) {
            $this->schema = new Schema();
        }
        return $this->schema;
    }
    
    /**
     * {@inheritdoc}
     */
    public function condition($conjunction) {
        return new StubCondition($conjunction);
    }
    
    /**
     * {@inheritdoc}
     */
    public function startTransaction($name = '') {
        return new Transaction($this, $name);
    }

}