bit-badger/pdo-document
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 18 Wiki Activity

Add classes and tests from common project

Browse Source
This commit is contained in:
Daniel J. Summers
2024-06-03 19:46:39 -04:00
parent e91acee70f
commit 1164dc7cc5
32 changed files with 3175 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
src/Configuration.php Normal file
View File

@@ -0,0 +1,32 @@
<?php declare(strict_types=1);
namespace BitBadger\PDODocument;
/**
* Common configuration for the document library
*/
class Configuration
{
/** @var string The name of the ID field used in the database (will be treated as the primary key) */
private static string $_idField = 'id';
/**
* Configure the ID field used by the library
*
* @param string $name The name of the ID field within each document
*/
public static function useIdField(string $name): void
{
self::$_idField = $name;
}
/**
* Retrieve the ID field for documents within this library
*
* @return string The configured ID field
*/
public static function idField(): string
{
return self::$_idField;
}
}

30
src/DocumentException.php Normal file
View File

@@ -0,0 +1,30 @@
<?php declare(strict_types=1);
namespace BitBadger\PDODocument;
use Exception;
use Throwable;
/**
* Exceptions occurring during document processing
*/
class DocumentException extends Exception
{
/**
* Constructor
*
* @param string $message A message for the exception
* @param int $code The code for the exception (optional; defaults to 0)
* @param Throwable|null $previous The previous exception (optional; defaults to `null`)
*/
public function __construct(string $message, int $code = 0, ?Throwable $previous = null)
{
parent::__construct($message, $code, $previous);
}
public function __toString(): string
{
$codeStr = $this->code == 0 ? '' : "[$this->code] ";
return __CLASS__ . ": $codeStr$this->message\n";
}
}

36
src/DocumentList.php Normal file
View File

@@ -0,0 +1,36 @@
<?php declare(strict_types=1);
namespace BitBadger\PDODocument;
use Generator;
/**
* A lazy iterator of results in a list; implementations will create new connections to the database and close/dispose
* them as required once the results have been exhausted.
*
* @template TDoc The domain class for items returned by this list
*/
interface DocumentList
{
/**
* The items from the query result
*
* @return Generator<TDoc> The query results as a lazily-iterated generator
*/
public function items(): Generator;
/**
* Construct a new document list
*
* @param string $query The query to run to retrieve results
* @param array $parameters An associative array of parameters for the query
* @param Mapper<TDoc> $mapper A mapper to deserialize JSON documents
* @return static The `DocumentList`-implementing instance
*/
public static function create(string $query, array $parameters, Mapper $mapper): static;
/**
* Clean up database connection resources
*/
public function __destruct();
}

176
src/Field.php Normal file
View File

@@ -0,0 +1,176 @@
<?php declare(strict_types=1);
namespace BitBadger\PDODocument;
/**
* Criteria for a field WHERE clause
*/
class Field
{
/**
* Constructor
*
* NOTE: Use static construction methods rather than using this directly; different properties are required
* depending on the operation being performed. This is only public so it can be tested.
*
* @param string $fieldName The name of the field
* @param Op $op The operation by which the field will be compared
* @param mixed $value The value of the field
* @param string $paramName The name of the parameter to which this should be bound
* @param string $qualifier A table qualifier for the `data` column
*/
public function __construct(public string $fieldName = '', public Op $op = Op::EQ, public mixed $value = '',
public string $paramName = '', public string $qualifier = '') { }
/**
* Append the parameter name and value to the given associative array
*
* @param array $existing The existing parameters
* @return array The given parameter array with this field's name and value appended
*/
public function appendParameter(array $existing): array
{
switch ($this->op) {
case Op::EX:
case Op::NEX:
break;
case Op::BT:
$existing["{$this->paramName}min"] = $this->value[0];
$existing["{$this->paramName}max"] = $this->value[1];
break;
default:
$existing[$this->paramName] = $this->value;
}
return $existing;
}
/**
* Get the WHERE clause fragment for this parameter
*
* @return string The WHERE clause fragment for this parameter
*/
public function toWhere(): string
{
$criteria = match ($this->op) {
Op::EX, Op::NEX => '',
Op::BT => " {$this->paramName}min AND {$this->paramName}max",
default => " $this->paramName"
};
$prefix = $this->qualifier == '' ? '' : "$this->qualifier.";
return "{$prefix}data->>'$this->fieldName' " . $this->op->toString() . $criteria;
}
/**
* Create an equals (=) field criterion
*
* @param string $fieldName The name of the field against which the value will be compared
* @param mixed $value The value for which equality will be checked
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
* @return static The field with the requested criterion
*/
public static function EQ(string $fieldName, mixed $value, string $paramName = ''): static
{
return new static($fieldName, Op::EQ, $value, $paramName);
}
/**
* Create a greater than (>) field criterion
*
* @param string $fieldName The name of the field against which the value will be compared
* @param mixed $value The value for the greater than comparison
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
* @return static The field with the requested criterion
*/
public static function GT(string $fieldName, mixed $value, string $paramName = ''): static
{
return new static($fieldName, Op::GT, $value, $paramName);
}
/**
* Create a greater than or equal to (>=) field criterion
*
* @param string $fieldName The name of the field against which the value will be compared
* @param mixed $value The value for the greater than or equal to comparison
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
* @return static The field with the requested criterion
*/
public static function GE(string $fieldName, mixed $value, string $paramName = ''): static
{
return new static($fieldName, Op::GE, $value, $paramName);
}
/**
* Create a less than (<) field criterion
*
* @param string $fieldName The name of the field against which the value will be compared
* @param mixed $value The value for the less than comparison
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
* @return static The field with the requested criterion
*/
public static function LT(string $fieldName, mixed $value, string $paramName = ''): static
{
return new static($fieldName, Op::LT, $value, $paramName);
}
/**
* Create a less than or equal to (<=) field criterion
*
* @param string $fieldName The name of the field against which the value will be compared
* @param mixed $value The value for the less than or equal to comparison
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
* @return static The field with the requested criterion
*/
public static function LE(string $fieldName, mixed $value, string $paramName = ''): static
{
return new static($fieldName, Op::LE, $value, $paramName);
}
/**
* Create a not equals (<>) field criterion
*
* @param string $fieldName The name of the field against which the value will be compared
* @param mixed $value The value for the not equals comparison
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
* @return static The field with the requested criterion
*/
public static function NE(string $fieldName, mixed $value, string $paramName = ''): static
{
return new static($fieldName, Op::NE, $value, $paramName);
}
/**
* Create a BETWEEN field criterion
*
* @param string $fieldName The name of the field against which the value will be compared
* @param mixed $minValue The lower value for range
* @param mixed $maxValue The upper value for the range
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
* @return static The field with the requested criterion
*/
public static function BT(string $fieldName, mixed $minValue, mixed $maxValue, string $paramName = ''): static
{
return new static($fieldName, Op::BT, [$minValue, $maxValue], $paramName);
}
/**
* Create an exists (IS NOT NULL) field criterion
*
* @param string $fieldName The name of the field for which existence will be checked
* @return static The field with the requested criterion
*/
public static function EX(string $fieldName): static
{
return new static($fieldName, Op::EX, '', '');
}
/**
* Create a not exists (IS NULL) field criterion
*
* @param string $fieldName The name of the field for which non-existence will be checked
* @return static The field with the requested criterion
*/
public static function NEX(string $fieldName): static
{
return new static($fieldName, Op::NEX, '', '');
}
}

17
src/Mapper/ArrayMapper.php Normal file
View File

@@ -0,0 +1,17 @@
<?php declare(strict_types=1);
namespace BitBadger\PDODocument\Mapper;
/**
* A mapper that returns the associative array from the database
*/
class ArrayMapper implements Mapper
{
/**
* @inheritDoc
*/
public function map(array $result): array
{
return $result;
}
}

43
src/Mapper/JsonMapper.php Normal file
View File

@@ -0,0 +1,43 @@
<?php declare(strict_types=1);
namespace BitBadger\PDODocument\Mapper;
use BitBadger\PDODocument\DocumentException;
use JsonMapper_Exception;
/**
* Map domain class instances from JSON documents
*
* @template TDoc The type of document returned by this mapper
* @implements Mapper<TDoc> Provide a mapping from JSON
*/
class JsonMapper implements Mapper
{
/**
* Constructor
*
* @param class-string<TDoc> $className The type of class to be returned by this mapping
* @param string $fieldName The name of the field (optional; defaults to `data`)
*/
public function __construct(public string $className, public string $fieldName = 'data') { }
/**
* Map a result to a domain class instance
*
* @param array $result An associative array representing a single database result
* @return TDoc The document, deserialized from its JSON representation
* @throws DocumentException If the JSON cannot be deserialized
*/
public function map(array $result): mixed
{
try {
$json = json_decode($result[$this->fieldName]);
if (is_null($json)) {
throw new DocumentException("Could not map document for $this->className: " . json_last_error_msg());
}
return (new \JsonMapper())->map($json, $this->className);
} catch (JsonMapper_Exception $ex) {
throw new DocumentException("Could not map document for $this->className", previous: $ex);
}
}
}

19
src/Mapper/Mapper.php Normal file
View File

@@ -0,0 +1,19 @@
<?php declare(strict_types=1);
namespace BitBadger\PDODocument\Mapper;
/**
* Map an associative array of results to a domain class
*
* @template T The type of document retrieved by this mapper
*/
interface Mapper
{
/**
* Map a result to the specified type
*
* @param array $result An associative array representing a single database result
* @return T The item mapped from the given result
*/
public function map(array $result): mixed;
}

30
src/Mapper/StringMapper.php Normal file
View File

@@ -0,0 +1,30 @@
<?php declare(strict_types=1);
namespace BitBadger\PDODocument\Mapper;
/**
* Map a string result from the given
*
* @implements Mapper<string>
*/
class StringMapper implements Mapper
{
/**
* Constructor
*
* @param string $fieldName The name of the field to be retrieved as a string
*/
public function __construct(public string $fieldName) { }
/**
* @inheritDoc
*/
public function map(array $result): ?string
{
return match (false) {
key_exists($this->fieldName, $result) => null,
is_string($result[$this->fieldName]) => "{$result[$this->fieldName]}",
default => $result[$this->fieldName]
};
}
}

48
src/Op.php Normal file
View File

@@ -0,0 +1,48 @@
<?php declare(strict_types=1);
namespace BitBadger\PDODocument;
/**
* The types of logical operations allowed for JSON fields
*/
enum Op
{
/** Equals (=) */
case EQ;
/** Greater Than (>) */
case GT;
/** Greater Than or Equal To (>=) */
case GE;
/** Less Than (<) */
case LT;
/** Less Than or Equal To (<=) */
case LE;
/** Not Equal to (<>) */
case NE;
/** Between (BETWEEN) */
case BT;
/** Exists (IS NOT NULL) */
case EX;
/** Does Not Exist (IS NULL) */
case NEX;
/**
* Get the string representation of this operator
*
* @return string The operator to use in SQL statements
*/
public function toString(): string
{
return match ($this) {
Op::EQ => "=",
Op::GT => ">",
Op::GE => ">=",
Op::LT => "<",
Op::LE => "<=",
Op::NE => "<>",
Op::BT => "BETWEEN",
Op::EX => "IS NOT NULL",
Op::NEX => "IS NULL"
};
}
}

77
src/Query.php Normal file
View File

@@ -0,0 +1,77 @@
<?php declare(strict_types=1);
namespace BitBadger\PDODocument;
/**
* Query construction functions
*/
class Query
{
/**
* Create a SELECT clause to retrieve the document data from the given table
*
* @param string $tableName The name of the table from which document data should be retrieved
* @return string The SELECT clause to retrieve a document from the given table
*/
public static function selectFromTable(string $tableName): string
{
return "SELECT data FROM $tableName";
}
/**
* Create a WHERE clause fragment to implement a comparison on fields in a JSON document
*
* @param Field[] $fields The field comparison to generate
* @param string $conjunction How to join multiple conditions (optional; defaults to AND)
* @return string The WHERE clause fragment matching the given fields and parameter
*/
public static function whereByFields(array $fields, string $conjunction = 'AND'): string
{
return implode(" $conjunction ", array_map(fn($it) => $it->toWhere(), $fields));
}
/**
* Create a WHERE clause fragment to implement an ID-based query
*
* @param string $paramName The parameter name where the value of the ID will be provided (optional; default @id)
* @return string The WHERE clause fragment to match by ID
*/
public static function whereById(string $paramName = '@id'): string
{
return self::whereByFields([Field::EQ(Configuration::idField(), 0, $paramName)]);
}
/**
* Query to insert a document
*
* @param string $tableName The name of the table into which a document should be inserted
* @return string The INSERT statement for the given table
*/
public static function insert(string $tableName): string
{
return "INSERT INTO $tableName VALUES (@data)";
}
/**
* Query to save a document, inserting it if it does not exist and updating it if it does (AKA "upsert")
*
* @param string $tableName The name of the table into which a document should be saved
* @return string The INSERT...ON CONFLICT query for the document
*/
public static function save(string $tableName): string
{
return self::insert($tableName)
. " ON CONFLICT ((data->>'" . Configuration::idField() . "')) DO UPDATE SET data = EXCLUDED.data";
}
/**
* Query to update a document
*
* @param string $tableName The name of the table in which the document should be updated
* @return string The UPDATE query for the document
*/
public static function update(string $tableName): string
{
return "UPDATE $tableName SET data = @data WHERE " . self::whereById();
}
}

36
src/Query/Count.php Normal file
View File

@@ -0,0 +1,36 @@
<?php declare(strict_types=1);
namespace BitBadger\PDODocument\Query;
use BitBadger\PDODocument\Field;
use BitBadger\PDODocument\Query;
/**
* Queries for counting documents
*/
class Count
{
/**
* Query to count all documents in a table
*
* @param string $tableName The name of the table in which documents should be counted
* @return string The query to count all documents in a table
*/
public static function all(string $tableName): string
{
return "SELECT COUNT(*) FROM $tableName";
}
/**
* Query to count matching documents using a text comparison on JSON fields
*
* @param string $tableName The name of the table in which documents should be counted
* @param Field[] $fields The field comparison to match
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
* @return string The query to count documents using a field comparison
*/
public static function byFields(string $tableName, array $fields, string $conjunction = 'AND'): string
{
return self::all($tableName) . ' WHERE ' . Query::whereByFields($fields, $conjunction);
}
}

66
src/Query/Definition.php Normal file
View File

@@ -0,0 +1,66 @@
<?php declare(strict_types=1);
namespace BitBadger\PDODocument\Query;
use BitBadger\PDODocument\Configuration;
/**
* Queries to define tables and indexes
*/
class Definition
{
/**
* SQL statement to create a document table
*
* @param string $name The name of the table (including schema, if applicable)
* @param string $dataType The data type used for the document column
* @return string The CREATE TABLE statement for the document table
*/
public static function ensureTableFor(string $name, string $dataType): string
{
return "CREATE TABLE IF NOT EXISTS $name (data $dataType NOT NULL)";
}
/**
* Split a schema and table name
*
* @param string $tableName The name of the table, possibly including the schema
* @return array|string[] An array with the schema at index 0 and the table name at index 1
*/
private static function splitSchemaAndTable(string $tableName): array
{
$parts = explode('.', $tableName);
return sizeof($parts) == 1 ? ["", $tableName] : [$parts[0], $parts[1]];
}
/**
* SQL statement to create an index on one or more fields in a JSON document
*
* @param string $tableName The name of the table which should be indexed
* @param string $indexName The name of the index to create
* @param array $fields An array of fields to be indexed; may contain direction (ex. 'salary DESC')
* @return string The CREATE INDEX statement to ensure the index exists
*/
public static function ensureIndexOn(string $tableName, string $indexName, array $fields): string
{
[, $tbl] = self::splitSchemaAndTable($tableName);
$jsonFields = implode(', ', array_map(function (string $field) {
$parts = explode(' ', $field);
$fieldName = sizeof($parts) == 1 ? $field : $parts[0];
$direction = sizeof($parts) < 2 ? "" : " $parts[1]";
return "(data->>'$fieldName')$direction";
}, $fields));
return "CREATE INDEX IF NOT EXISTS idx_{$tbl}_$indexName ON $tableName ($jsonFields)";
}
/**
* SQL statement to create a key index for a document table
*
* @param string $tableName The name of the table whose key should be ensured
* @return string The CREATE INDEX statement to ensure the key index exists
*/
public static function ensureKey(string $tableName): string
{
return str_replace('INDEX', 'UNIQUE INDEX', self::ensureIndexOn($tableName, 'key', [Configuration::idField()]));
}
}

36
src/Query/Delete.php Normal file
View File

@@ -0,0 +1,36 @@
<?php declare(strict_types=1);
namespace BitBadger\PDODocument\Query;
use BitBadger\PDODocument\Field;
use BitBadger\PDODocument\Query;
/**
* Queries to delete documents
*/
class Delete
{
/**
* Query to delete a document by its ID
*
* @param string $tableName The name of the table from which a document should be deleted
* @return string The DELETE statement to delete a document by its ID
*/
public static function byId(string $tableName): string
{
return "DELETE FROM $tableName WHERE " . Query::whereById();
}
/**
* Query to delete documents using a comparison on JSON fields
*
* @param string $tableName The name of the table from which documents should be deleted
* @param Field[] $fields The field comparison to match
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
* @return string The DELETE statement to delete documents via field comparison
*/
public static function byFields(string $tableName, array $fields, string $conjunction = 'AND'): string
{
return "DELETE FROM $tableName WHERE " . Query::whereByFields($fields, $conjunction);
}
}

48
src/Query/Exists.php Normal file
View File

@@ -0,0 +1,48 @@
<?php declare(strict_types=1);
namespace BitBadger\PDODocument\Query;
use BitBadger\PDODocument\Field;
use BitBadger\PDODocument\Query;
/**
* Queries to determine document existence
*/
class Exists
{
/**
* The shell of a query for an existence check
*
* @param string $tableName The name of the table in which existence should be checked
* @param string $whereClause The conditions for which existence should be checked
* @return string The query to determine existence of documents
*/
public static function query(string $tableName, string $whereClause): string
{
return "SELECT EXISTS (SELECT 1 FROM $tableName WHERE $whereClause)";
}
/**
* Query to determine if a document exists for the given ID
*
* @param string $tableName The name of the table in which document existence should be checked
* @return string The query to determine document existence by ID
*/
public static function byId(string $tableName): string
{
return self::query($tableName, Query::whereById());
}
/**
* Query to determine if documents exist using a comparison on JSON fields
*
* @param string $tableName The name of the table in which document existence should be checked
* @param Field[] $fields The field comparison to match
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
* @return string The query to determine document existence by field comparison
*/
public static function byFields(string $tableName, array $fields, string $conjunction = 'AND'): string
{
return self::query($tableName, Query::whereByFields($fields, $conjunction));
}
}

36
src/Query/Find.php Normal file
View File

@@ -0,0 +1,36 @@
<?php declare(strict_types=1);
namespace BitBadger\PDODocument\Query;
use BitBadger\PDODocument\Field;
use BitBadger\PDODocument\Query;
/**
* Queries for retrieving documents
*/
class Find
{
/**
* Query to retrieve a document by its ID
*
* @param string $tableName The name of the table from which a document should be retrieved
* @return string The SELECT statement to retrieve a document by its ID
*/
public static function byId(string $tableName): string
{
return Query::selectFromTable($tableName) . ' WHERE ' . Query::whereById();
}
/**
* Query to retrieve documents using a comparison on JSON fields
*
* @param string $tableName The name of the table from which documents should be retrieved
* @param Field[] $fields The field comparison to match
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
* @return string The SELECT statement to retrieve documents by field comparison
*/
public static function byFields(string $tableName, array $fields, string $conjunction = 'AND'): string
{
return Query::selectFromTable($tableName) . ' WHERE ' . Query::whereByFields($fields, $conjunction);
}
}