Database
in package
Database object.
Table of Contents
- DSN_PATH_MEMORY = ':memory:'
- $connection : PDO
- $collections : array<string|int, mixed>
- $document_criterias : array<string|int, mixed>
- $path : string
- __construct() : mixed
- Constructor
- __get() : mixed
- callCriteriaFunction() : bool
- Execute registred criteria function
- createCollection() : void
- Create a collection
- drop() : void
- Drop database
- dropCollection() : void
- Drop a collection
- getCollectionNames() : array<string|int, mixed>
- Get all collection names in the database
- listCollections() : array<string|int, mixed>
- Get all collections in the database
- registerCriteriaFunction() : mixed
- Register Criteria function
- selectCollection() : object
- Select collection
- vacuum() : void
- Vacuum database
Constants
DSN_PATH_MEMORY
public
string
DSN_PATH_MEMORY
= ':memory:'
- DSN path form memory database
Properties
$connection
public
PDO
$connection
object
$collections
protected
array<string|int, mixed>
$collections
= []
$document_criterias
protected
array<string|int, mixed>
$document_criterias
= []
$path
protected
string
$path
Methods
__construct()
Constructor
public
__construct([string $path = self::DSN_PATH_MEMORY ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $path : string = self::DSN_PATH_MEMORY
- $options : array<string|int, mixed> = []
Return values
mixed —__get()
public
__get(mixed $collection) : mixed
Parameters
- $collection : mixed
Return values
mixed —callCriteriaFunction()
Execute registred criteria function
public
callCriteriaFunction(string $id, array<string|int, mixed> $document) : bool
Parameters
- $id : string
- $document : array<string|int, mixed>
Return values
bool —createCollection()
Create a collection
public
createCollection(string $name) : void
Parameters
- $name : string
Return values
void —drop()
Drop database
public
drop() : void
Return values
void —dropCollection()
Drop a collection
public
dropCollection(string $name) : void
Parameters
- $name : string
Return values
void —getCollectionNames()
Get all collection names in the database
public
getCollectionNames() : array<string|int, mixed>
Return values
array<string|int, mixed> —listCollections()
Get all collections in the database
public
listCollections() : array<string|int, mixed>
Return values
array<string|int, mixed> —registerCriteriaFunction()
Register Criteria function
public
registerCriteriaFunction(mixed $criteria) : mixed
Parameters
- $criteria : mixed
Return values
mixed —selectCollection()
Select collection
public
selectCollection(string $name) : object
Parameters
- $name : string
Return values
object —vacuum()
Vacuum database
public
vacuum() : void