FetchTest.php

<?php

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

use Drupal\Core\Database\RowCountException;
use Drupal\Core\Database\StatementInterface;
use Drupal\Tests\system\Functional\Database\FakeRecord;

/**
 * Tests the Database system's various fetch capabilities.
 *
 * We get timeout errors if we try to run too many tests at once.
 *
 * @group Database
 */
class FetchTest extends DatabaseTestBase {

  /**
   * Confirms that we can fetch a record properly in default object mode.
   */
  public function testQueryFetchDefault() {
    $records = [];
    $result = $this->connection
      ->query('SELECT [name] FROM {test} WHERE [age] = :age', [
      ':age' => 25,
    ]);
    $this
      ->assertInstanceOf(StatementInterface::class, $result);
    foreach ($result as $record) {
      $records[] = $record;
      $this
        ->assertIsObject($record);
      $this
        ->assertSame('John', $record->name);
    }
    $this
      ->assertCount(1, $records, 'There is only one record.');
  }

  /**
   * Confirms that we can fetch a record to an object explicitly.
   */
  public function testQueryFetchObject() {
    $records = [];
    $result = $this->connection
      ->query('SELECT [name] FROM {test} WHERE [age] = :age', [
      ':age' => 25,
    ], [
      'fetch' => \PDO::FETCH_OBJ,
    ]);
    foreach ($result as $record) {
      $records[] = $record;
      $this
        ->assertIsObject($record);
      $this
        ->assertSame('John', $record->name);
    }
    $this
      ->assertCount(1, $records, 'There is only one record.');
  }

  /**
   * Confirms that we can fetch a record to an associative array explicitly.
   */
  public function testQueryFetchArray() {
    $records = [];
    $result = $this->connection
      ->query('SELECT [name] FROM {test} WHERE [age] = :age', [
      ':age' => 25,
    ], [
      'fetch' => \PDO::FETCH_ASSOC,
    ]);
    foreach ($result as $record) {
      $records[] = $record;
      $this
        ->assertIsArray($record);
      $this
        ->assertArrayHasKey('name', $record);
      $this
        ->assertSame('John', $record['name']);
    }
    $this
      ->assertCount(1, $records, 'There is only one record.');
  }

  /**
   * Confirms that we can fetch a record into a new instance of a custom class.
   *
   * @see \Drupal\system\Tests\Database\FakeRecord
   */
  public function testQueryFetchClass() {
    $records = [];
    $result = $this->connection
      ->query('SELECT [name] FROM {test} WHERE [age] = :age', [
      ':age' => 25,
    ], [
      'fetch' => FakeRecord::class,
    ]);
    foreach ($result as $record) {
      $records[] = $record;
      $this
        ->assertInstanceOf(FakeRecord::class, $record);
      $this
        ->assertSame('John', $record->name);
    }
    $this
      ->assertCount(1, $records, 'There is only one record.');
  }

  /**
   * Confirms that we can fetch a record into a class using fetchObject.
   *
   * @see \Drupal\Tests\system\Functional\Database\FakeRecord
   * @see \Drupal\Core\Database\StatementPrefetch::fetchObject
   */
  public function testQueryFetchObjectClass() {
    $records = 0;
    $query = $this->connection
      ->query('SELECT [name] FROM {test} WHERE [age] = :age', [
      ':age' => 25,
    ]);
    while ($result = $query
      ->fetchObject(FakeRecord::class, [
      1,
    ])) {
      $records += 1;
      $this
        ->assertInstanceOf(FakeRecord::class, $result);
      $this
        ->assertSame('John', $result->name, '25 year old is John.');
      $this
        ->assertSame(1, $result->fakeArg, 'The record has received an argument through its constructor.');
    }
    $this
      ->assertSame(1, $records, 'There is only one record.');
  }

  /**
   * Confirms that we can fetch a record into a class without constructor args.
   *
   * @see \Drupal\Tests\system\Functional\Database\FakeRecord
   * @see \Drupal\Core\Database\StatementPrefetch::fetchObject
   */
  public function testQueryFetchObjectClassNoConstructorArgs() : void {
    $records = 0;
    $query = $this->connection
      ->query('SELECT [name] FROM {test} WHERE [age] = :age', [
      ':age' => 25,
    ]);
    while ($result = $query
      ->fetchObject(FakeRecord::class)) {
      $records += 1;
      $this
        ->assertInstanceOf(FakeRecord::class, $result);
      $this
        ->assertSame('John', $result->name);
      $this
        ->assertSame(0, $result->fakeArg);
    }
    $this
      ->assertSame(1, $records);
  }

  /**
   * Confirms that we can fetch a record into a new instance of a custom class.
   *
   * The name of the class is determined from a value of the first column.
   *
   * @see \Drupal\Tests\system\Functional\Database\FakeRecord
   *
   * @group legacy
   */
  public function testQueryFetchClasstype() {
    $this
      ->expectDeprecation('Fetch mode FETCH_CLASS | FETCH_CLASSTYPE is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. Use supported modes only. See https://www.drupal.org/node/3377999');
    $records = [];
    $result = $this->connection
      ->query('SELECT [classname], [name], [job] FROM {test_classtype} WHERE [age] = :age', [
      ':age' => 26,
    ], [
      'fetch' => \PDO::FETCH_CLASS | \PDO::FETCH_CLASSTYPE,
    ]);
    foreach ($result as $record) {
      $records[] = $record;
      $this
        ->assertInstanceOf(FakeRecord::class, $record);
      $this
        ->assertSame('Kay', $record->name);
      $this
        ->assertSame('Web Developer', $record->job);
      $this
        ->assertFalse(isset($record->classname), 'Classname field not found, as intended.');
    }
    $this
      ->assertCount(1, $records, 'There is only one record.');
  }

  /**
   * Confirms that we can fetch a record into an indexed array explicitly.
   */
  public function testQueryFetchNum() {
    $records = [];
    $result = $this->connection
      ->query('SELECT [name] FROM {test} WHERE [age] = :age', [
      ':age' => 25,
    ], [
      'fetch' => \PDO::FETCH_NUM,
    ]);
    foreach ($result as $record) {
      $records[] = $record;
      $this
        ->assertIsArray($record);
      $this
        ->assertArrayHasKey(0, $record);
      $this
        ->assertSame('John', $record[0]);
    }
    $this
      ->assertCount(1, $records, 'There is only one record');
  }

  /**
   * Confirms that we can fetch a record into a doubly-keyed array explicitly.
   *
   * @group legacy
   */
  public function testQueryFetchBoth() {
    $this
      ->expectDeprecation('Fetch mode FETCH_BOTH is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. Use supported modes only. See https://www.drupal.org/node/3377999');
    $records = [];
    $result = $this->connection
      ->query('SELECT [name] FROM {test} WHERE [age] = :age', [
      ':age' => 25,
    ], [
      'fetch' => \PDO::FETCH_BOTH,
    ]);
    foreach ($result as $record) {
      $records[] = $record;
      $this
        ->assertIsArray($record);
      $this
        ->assertArrayHasKey(0, $record);
      $this
        ->assertSame('John', $record[0]);
      $this
        ->assertArrayHasKey('name', $record);
      $this
        ->assertSame('John', $record['name']);
    }
    $this
      ->assertCount(1, $records, 'There is only one record.');
  }

  /**
   * Confirms that we can fetch all records into an array explicitly.
   */
  public function testQueryFetchAllColumn() {
    $query = $this->connection
      ->select('test');
    $query
      ->addField('test', 'name');
    $query
      ->orderBy('name');
    $query_result = $query
      ->execute()
      ->fetchAll(\PDO::FETCH_COLUMN);
    $expected_result = [
      'George',
      'John',
      'Paul',
      'Ringo',
    ];
    $this
      ->assertEquals($expected_result, $query_result, 'Returned the correct result.');
  }

  /**
   * Confirms that we can fetch an entire column of a result set at once.
   */
  public function testQueryFetchCol() {
    $result = $this->connection
      ->query('SELECT [name] FROM {test} WHERE [age] > :age', [
      ':age' => 25,
    ]);
    $column = $result
      ->fetchCol();
    $this
      ->assertCount(3, $column, 'fetchCol() returns the right number of records.');
    $result = $this->connection
      ->query('SELECT [name] FROM {test} WHERE [age] > :age', [
      ':age' => 25,
    ]);
    $i = 0;
    foreach ($result as $record) {
      $this
        ->assertSame($column[$i++], $record->name, 'Column matches direct access.');
    }
  }

  /**
   * Tests ::fetchAllAssoc().
   */
  public function testQueryFetchAllAssoc() : void {
    $expected_result = [
      "Singer" => [
        "id" => "2",
        "name" => "George",
        "age" => "27",
        "job" => "Singer",
      ],
      "Drummer" => [
        "id" => "3",
        "name" => "Ringo",
        "age" => "28",
        "job" => "Drummer",
      ],
    ];
    $statement = $this->connection
      ->query('SELECT * FROM {test} WHERE [age] > :age', [
      ':age' => 26,
    ]);
    $result = $statement
      ->fetchAllAssoc('job', \PDO::FETCH_ASSOC);
    $this
      ->assertSame($expected_result, $result);
    $statement = $this->connection
      ->query('SELECT * FROM {test} WHERE [age] > :age', [
      ':age' => 26,
    ]);
    $result = $statement
      ->fetchAllAssoc('job', \PDO::FETCH_OBJ);
    $this
      ->assertEquals((object) $expected_result['Singer'], $result['Singer']);
    $this
      ->assertEquals((object) $expected_result['Drummer'], $result['Drummer']);
  }

  /**
   * Tests ::fetchField().
   */
  public function testQueryFetchField() : void {
    $this->connection
      ->insert('test')
      ->fields([
      'name' => 'Foo',
      'age' => 0,
      'job' => 'Dummy',
    ])
      ->execute();
    $this->connection
      ->insert('test')
      ->fields([
      'name' => 'Kurt',
      'age' => 27,
      'job' => 'Singer',
    ])
      ->execute();
    $expectedResults = [
      '25',
      '27',
      '28',
      '26',
      '0',
      '27',
    ];
    $statement = $this->connection
      ->select('test')
      ->fields('test', [
      'age',
    ])
      ->orderBy('id')
      ->execute();
    $actualResults = [];
    while (TRUE) {
      $result = $statement
        ->fetchField();
      if ($result === FALSE) {
        break;
      }
      $this
        ->assertIsNumeric($result);
      $actualResults[] = $result;
    }
    $this
      ->assertSame($expectedResults, $actualResults);
  }

  /**
   * Tests that rowCount() throws exception on SELECT query.
   */
  public function testRowCount() {
    $result = $this->connection
      ->query('SELECT [name] FROM {test}');
    try {
      $result
        ->rowCount();
      $exception = FALSE;
    } catch (RowCountException $e) {
      $exception = TRUE;
    }
    $this
      ->assertTrue($exception, 'Exception was thrown');
  }

}