74 lines
3.0 KiB
PHP
74 lines
3.0 KiB
PHP
<?php
|
|
/**
|
|
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
|
* @license MIT
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace BitBadger\PDODocument;
|
|
|
|
use BitBadger\PDODocument\Mapper\ExistsMapper;
|
|
|
|
/**
|
|
* Functions to determine if documents exist
|
|
*/
|
|
class Exists
|
|
{
|
|
/**
|
|
* Determine if a document exists for the given ID
|
|
*
|
|
* @param string $tableName The name of the table in which document existence should be determined
|
|
* @param mixed $docId The ID of the document whose existence should be determined
|
|
* @return bool True if the document exists, false if not
|
|
* @throws DocumentException If any is encountered
|
|
*/
|
|
public static function byId(string $tableName, mixed $docId): bool
|
|
{
|
|
return Custom::scalar(Query\Exists::byId($tableName, $docId), Parameters::id($docId), new ExistsMapper());
|
|
}
|
|
|
|
/**
|
|
* Determine if a document exists using a comparison on JSON fields
|
|
*
|
|
* @param string $tableName The name of the table in which document existence should be determined
|
|
* @param Field[] $fields The field comparison to match
|
|
* @param FieldMatch|null $match How to handle multiple conditions (optional; defaults to All)
|
|
* @return bool True if any documents match the field comparison, false if not
|
|
* @throws DocumentException If any is encountered
|
|
*/
|
|
public static function byFields(string $tableName, array $fields, ?FieldMatch $match = null): bool
|
|
{
|
|
$namedFields = Parameters::nameFields($fields);
|
|
return Custom::scalar(Query\Exists::byFields($tableName, $namedFields, $match),
|
|
Parameters::addFields($namedFields, []), new ExistsMapper());
|
|
}
|
|
|
|
/**
|
|
* Determine if documents exist by a JSON containment query (`@>`; PostgreSQL only)
|
|
*
|
|
* @param string $tableName The name of the table in which document existence should be determined
|
|
* @param mixed[]|object $criteria The criteria for the JSON containment query
|
|
* @return bool True if any documents match the JSON containment query, false if not
|
|
* @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
|
|
*/
|
|
public static function byContains(string $tableName, array|object $criteria): bool
|
|
{
|
|
return Custom::scalar(Query\Exists::byContains($tableName), Parameters::json(':criteria', $criteria),
|
|
new ExistsMapper());
|
|
}
|
|
|
|
/**
|
|
* Determine if documents exist by a JSON Path match query (`@?`; PostgreSQL only)
|
|
*
|
|
* @param string $tableName The name of the table in which document existence should be determined
|
|
* @param string $path The JSON Path match string
|
|
* @return bool True if any documents match the JSON Path string, false if not
|
|
* @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
|
|
*/
|
|
public static function byJsonPath(string $tableName, string $path): bool
|
|
{
|
|
return Custom::scalar(Query\Exists::byJsonPath($tableName), [':path' => $path], new ExistsMapper());
|
|
}
|
|
}
|