PHP Интерфейс Bravo3\Orm\Drivers\DriverInterface

Наследование: extends Bravo3\Orm\Traits\DebugInterface
Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод Описание
addMultiValueIndex ( string $key, string | array $value ) : void Add one or many values to a list index
addRef ( string $key, Ref $ref ) : void Add a ref to an entity
addSortedIndex ( string $key, mixed $score, string $value ) : void Add or update an item in a sorted index
clearMultiValueIndex ( string $key ) : void Clear all values from a set index
clearRefs ( string $key ) : void Clear all refs from an entity (delete a ref list)
clearSingleValueIndex ( string $key ) : string Clear the value of a key-value index
clearSortedIndex ( string $key ) : void Clear an entire sorted index
delete ( string $key ) : void Delete a primitive document
flush ( ) : void Execute the current unit of work
getMultiValueIndex ( string $key ) : string[] Get a list of all values on a set index
getPreferredKeyScheme ( ) : Bravo3\Orm\KeySchemes\KeySchemeInterface Get the drivers preferred key scheme
getRefs ( string $key ) : Ref[] Get all refs to an entity
getSingleValueIndex ( string $key ) : string | null Get the value of a key-value index
getSortedIndex ( string $key, boolean $reverse = false, integer $start = null, integer $stop = null ) : string[] Get a range of values in a sorted index
getSortedIndexSize ( string $key ) : integer Get the size of a sorted index, without any filters applied
persist ( string $key, SerialisedData $data, integer $ttl = null ) : void Persist some primitive data
purge ( ) : void Purge the current unit of work, clearing any unexecuted commands
removeMultiValueIndex ( string $key, string | array $value ) : void Remove one or more values from a set index
removeRef ( string $key, Ref $ref ) : void Remove a ref from an entity
removeSortedIndex ( string $key, string $value ) : void Remove an item from a sorted index
retrieve ( string $key ) : SerialisedData Retrieve an object
scan ( string $key ) : string[] Scan key-value indices and return the value of all matching keys
setSingleValueIndex ( string $key, string $value ) : void Set a key-value index
validateId ( string $id ) : string[] Checks if a given entity ID is safe for the driver and returns an array of violation messages

Описание методов

addMultiValueIndex() публичный Метод

Add one or many values to a list index
public addMultiValueIndex ( string $key, string | array $value ) : void
$key string
$value string | array
Результат void

addRef() публичный Метод

Add a ref to an entity
public addRef ( string $key, Ref $ref ) : void
$key string Entity ref key
$ref Bravo3\Orm\Drivers\Common\Ref Reference to add
Результат void

addSortedIndex() публичный Метод

Add or update an item in a sorted index
public addSortedIndex ( string $key, mixed $score, string $value ) : void
$key string
$score mixed
$value string
Результат void

clearMultiValueIndex() публичный Метод

Clear all values from a set index
public clearMultiValueIndex ( string $key ) : void
$key string
Результат void

clearRefs() публичный Метод

Clear all refs from an entity (delete a ref list)
public clearRefs ( string $key ) : void
$key string
Результат void

clearSingleValueIndex() публичный Метод

Clear the value of a key-value index
public clearSingleValueIndex ( string $key ) : string
$key string
Результат string

clearSortedIndex() публичный Метод

Clear an entire sorted index
public clearSortedIndex ( string $key ) : void
$key string
Результат void

delete() публичный Метод

Delete a primitive document
public delete ( string $key ) : void
$key string
Результат void

flush() публичный Метод

Execute the current unit of work
public flush ( ) : void
Результат void

getMultiValueIndex() публичный Метод

If the key does not exist, an empty array should be returned.
public getMultiValueIndex ( string $key ) : string[]
$key string
Результат string[]

getPreferredKeyScheme() публичный Метод

Get the drivers preferred key scheme
public getPreferredKeyScheme ( ) : Bravo3\Orm\KeySchemes\KeySchemeInterface
Результат Bravo3\Orm\KeySchemes\KeySchemeInterface

getRefs() публичный Метод

Get all refs to an entity
public getRefs ( string $key ) : Ref[]
$key string Entity ref key
Результат Bravo3\Orm\Drivers\Common\Ref[]

getSingleValueIndex() публичный Метод

If the key does not exist, null should be returned.
public getSingleValueIndex ( string $key ) : string | null
$key string
Результат string | null

getSortedIndex() публичный Метод

If $start/$stop are === null, they are assumed to be the start/end of the entire set.
public getSortedIndex ( string $key, boolean $reverse = false, integer $start = null, integer $stop = null ) : string[]
$key string
$reverse boolean
$start integer
$stop integer
Результат string[]

getSortedIndexSize() публичный Метод

Get the size of a sorted index, without any filters applied
public getSortedIndexSize ( string $key ) : integer
$key string
Результат integer

persist() публичный Метод

Persist some primitive data
public persist ( string $key, SerialisedData $data, integer $ttl = null ) : void
$key string
$data Bravo3\Orm\Drivers\Common\SerialisedData
$ttl integer
Результат void

purge() публичный Метод

Purge the current unit of work, clearing any unexecuted commands
public purge ( ) : void
Результат void

removeMultiValueIndex() публичный Метод

Remove one or more values from a set index
public removeMultiValueIndex ( string $key, string | array $value ) : void
$key string
$value string | array
Результат void

removeRef() публичный Метод

If the reference does not exist, no action is taken.
public removeRef ( string $key, Ref $ref ) : void
$key string Entity ref key
$ref Bravo3\Orm\Drivers\Common\Ref Reference to remove
Результат void

removeSortedIndex() публичный Метод

Remove an item from a sorted index
public removeSortedIndex ( string $key, string $value ) : void
$key string
$value string
Результат void

retrieve() публичный Метод

Retrieve an object
public retrieve ( string $key ) : SerialisedData
$key string
Результат Bravo3\Orm\Drivers\Common\SerialisedData

scan() публичный Метод

Scan key-value indices and return the value of all matching keys
public scan ( string $key ) : string[]
$key string
Результат string[]

setSingleValueIndex() публичный Метод

Set a key-value index
public setSingleValueIndex ( string $key, string $value ) : void
$key string
$value string
Результат void

validateId() публичный Метод

The ID should be considered valid if the returned array is empty.
public validateId ( string $id ) : string[]
$id string
Результат string[]