DatabaseTable.php

Go to the documentation of this file.

<?php
 
namespace Drupal\dkan_datastore\Storage;
 
use Drupal\Core\Database\Connection;
use Dkan\Datastore\Resource;
use Drupal\dkan_common\LoggerTrait;
use Drupal\dkan_common\Storage\AbstractDatabaseTable;
use Psr\Log\LogLevel;
 
class DatabaseTable extends AbstractDatabaseTable implements \JsonSerializable {
 
  use LoggerTrait;
 
  private $resource;
 
  public function __construct(Connection $connection, Resource $resource) {
    // Set resource before calling the parent constructor. The parent calls
    // getTableName which we implement and needs the resource to operate.
    $this->resource = $resource;
    parent::__construct($connection);
  }
 
  public function getSummary() {
    $columns = array_keys($this->getSchema()['fields']);
    $numOfColumns = count($columns);
    $numOfRows = $this->count();
    return new TableSummary($numOfColumns, $columns, $numOfRows);
  }
 
  public function jsonSerialize() {
    return (object) ['resource' => $this->resource];
  }
 
  public static function hydrate(string $json) {
    $data = json_decode($json);
    $resource = Resource::hydrate(json_encode($data->resource));
 
    return new DatabaseTable(\Drupal::service('database'), $resource);
  }
 
  protected function getTableName() {
    if ($this->resource) {
      return "dkan_datastore_{$this->resource->getId()}";
    }
    return "dkan_datastore_does_not_exist";
  }
 
  protected function prepareData(string $data, string $id = NULL): array {
    $decoded = json_decode($data);
    if ($decoded === NULL) {
      $this->log(
        'dkan_datastore_import',
        "Error decoding id:@id, data: @data.",
        ['@id' => $id, '@data' => $data],
        LogLevel::ERROR
      );
      throw new \Exception("Import for {$id} error when decoding {$data}");
    }
    elseif (!is_array($decoded)) {
      $this->log(
        'dkan_datastore_import',
        "Array expected while decoding id:@id, data: @data.",
        ['@id' => $id, '@data' => $data],
        LogLevel::ERROR
      );
      throw new \Exception("Import for {$id} returned an error when preparing table header: {$data}");
    }
    return $decoded;
  }
 
  protected function primaryKey() {
    return "record_number";
  }
 
  protected function getNonSerialFields() {
    $fields = parent::getNonSerialFields();
    $index = array_search($this->primaryKey(), $fields);
    if ($index !== FALSE) {
      unset($fields[$index]);
    }
    return $fields;
  }
 
  public function setSchema($schema) {
    $fields = $schema['fields'];
    $new_field = [
      $this->primaryKey() =>
      [
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ],
    ];
    $fields = array_merge($new_field, $fields);
 
    $schema['fields'] = $fields;
    $schema['primary key'] = [$this->primaryKey()];
    parent::setSchema($schema);
  }
 
}