mirror of
https://github.com/danog/AsyncOrm.git
synced 2024-11-26 12:24:59 +01:00
Bump phpunit config & docs
This commit is contained in:
parent
e1c3efd92a
commit
a824426d98
@ -15,17 +15,19 @@ Attribute use to autoconfigure ORM properties.
|
||||
|
||||
|
||||
## Properties
|
||||
* `$keyType`: `\danog\AsyncOrm\KeyType` Key type.
|
||||
* `$valueType`: `\danog\AsyncOrm\ValueType` Value type.
|
||||
* `$cacheTtl`: `int<0, max>|null`
|
||||
* `$optimizeIfWastedMb`: `int<1, max>|null`
|
||||
* `$keyType`: `danog\AsyncOrm\KeyType` Key type.
|
||||
* `$valueType`: `danog\AsyncOrm\ValueType` Value type.
|
||||
* `$cacheTtl`: `(int<0, max> | null)` TTL of the cache, if null defaults to the value specified in the settings.
|
||||
|
||||
If zero disables caching.
|
||||
* `$optimizeIfWastedMb`: `(int<1, max> | null)` Optimize table if more than this many megabytes are wasted, if null defaults to the value specified in the settings.
|
||||
* `$tablePostfix`: `?string` Table name postfix, if null defaults to the property name.
|
||||
|
||||
## Method list:
|
||||
* [`__construct(\danog\AsyncOrm\KeyType $keyType, \danog\AsyncOrm\ValueType $valueType, ?int $cacheTtl = NULL, ?int $optimizeIfWastedMb = NULL, ?string $tablePostfix = NULL)`](#__construct-danog-asyncorm-keytype-keytype-danog-asyncorm-valuetype-valuetype-int-cachettl-null-int-optimizeifwastedmb-null-string-tablepostfix-null)
|
||||
* [`__construct(\danog\AsyncOrm\KeyType $keyType, \danog\AsyncOrm\ValueType $valueType, ?int $cacheTtl = NULL, ?int $optimizeIfWastedMb = NULL, ?string $tablePostfix = NULL)`](#__construct)
|
||||
|
||||
## Methods:
|
||||
### `__construct(\danog\AsyncOrm\KeyType $keyType, \danog\AsyncOrm\ValueType $valueType, ?int $cacheTtl = NULL, ?int $optimizeIfWastedMb = NULL, ?string $tablePostfix = NULL)`
|
||||
### <a name="__construct"></a> `__construct(\danog\AsyncOrm\KeyType $keyType, \danog\AsyncOrm\ValueType $valueType, ?int $cacheTtl = NULL, ?int $optimizeIfWastedMb = NULL, ?string $tablePostfix = NULL)`
|
||||
|
||||
|
||||
|
||||
|
@ -16,168 +16,168 @@ DB array interface.
|
||||
|
||||
|
||||
## Method list:
|
||||
* [`isset(\TKey $key): bool`](#isset-tkey-key-bool)
|
||||
* [`offsetGet(\TKey $offset): \TValue`](#offsetget-tkey-offset-tvalue)
|
||||
* [`offsetExists(\TKey $offset): bool`](#offsetexists-tkey-offset-bool)
|
||||
* [`offsetSet(\TKey $offset, \TValue $value): void`](#offsetset-tkey-offset-tvalue-value-void)
|
||||
* [`offsetUnset(\TKey $offset): void`](#offsetunset-tkey-offset-void)
|
||||
* [`getArrayCopy(): array`](#getarraycopy-array)
|
||||
* [`unset(\TKey $key): void`](#unset-tkey-key-void)
|
||||
* [`set(\TKey $key, \TValue $value): void`](#set-tkey-key-tvalue-value-void)
|
||||
* [`get(\TKey $key): ?\TValue`](#get-tkey-key-tvalue)
|
||||
* [`clear(): void`](#clear-void)
|
||||
* [`getInstance(\danog\AsyncOrm\DbArrayBuilder $config, ?self $previous): self`](#getinstance-danog-asyncorm-dbarraybuilder-config-self-previous-self)
|
||||
* [`count(): mixed`](#count-mixed)
|
||||
* [`getIterator(): mixed`](#getiterator-mixed)
|
||||
* [`isset(TKey $key): bool`](#isset)
|
||||
* [`offsetGet(TKey $offset): TValue`](#offsetGet)
|
||||
* [`offsetExists(TKey $offset): bool`](#offsetExists)
|
||||
* [`offsetSet(TKey $offset, TValue $value): void`](#offsetSet)
|
||||
* [`offsetUnset(TKey $offset): void`](#offsetUnset)
|
||||
* [`getArrayCopy(): array`](#getArrayCopy)
|
||||
* [`unset(TKey $key): void`](#unset)
|
||||
* [`set(TKey $key, TValue $value): void`](#set)
|
||||
* [`get(TKey $key): ?TValue`](#get)
|
||||
* [`clear(): void`](#clear)
|
||||
* [`getInstance(\danog\AsyncOrm\DbArrayBuilder $config, (\danog\AsyncOrm\DbArray<TTKey, TValue>|null) $previous): \danog\AsyncOrm\DbArray<TTKey, TValue>`](#getInstance)
|
||||
* [`count()`](#count)
|
||||
* [`getIterator()`](#getIterator)
|
||||
|
||||
## Methods:
|
||||
### `isset(\TKey $key): bool`
|
||||
### <a name="isset"></a> `isset(TKey $key): bool`
|
||||
|
||||
Check if element exists.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$key`: `\TKey`
|
||||
* `$key`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `TKey`
|
||||
|
||||
|
||||
|
||||
|
||||
### `offsetGet(\TKey $offset): \TValue`
|
||||
### <a name="offsetGet"></a> `offsetGet(TKey $offset): TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$offset`: `\TKey`
|
||||
* `$offset`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `\TValue`
|
||||
* `TKey`
|
||||
* `TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
### `offsetExists(\TKey $offset): bool`
|
||||
### <a name="offsetExists"></a> `offsetExists(TKey $offset): bool`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$offset`: `\TKey`
|
||||
* `$offset`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `TKey`
|
||||
|
||||
|
||||
|
||||
|
||||
### `offsetSet(\TKey $offset, \TValue $value): void`
|
||||
### <a name="offsetSet"></a> `offsetSet(TKey $offset, TValue $value): void`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$offset`: `\TKey`
|
||||
* `$value`: `\TValue`
|
||||
* `$offset`: `TKey`
|
||||
* `$value`: `TValue`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `\TValue`
|
||||
* `TKey`
|
||||
* `TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
### `offsetUnset(\TKey $offset): void`
|
||||
### <a name="offsetUnset"></a> `offsetUnset(TKey $offset): void`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$offset`: `\TKey`
|
||||
* `$offset`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `TKey`
|
||||
|
||||
|
||||
|
||||
|
||||
### `getArrayCopy(): array`
|
||||
### <a name="getArrayCopy"></a> `getArrayCopy(): array`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### `unset(\TKey $key): void`
|
||||
### <a name="unset"></a> `unset(TKey $key): void`
|
||||
|
||||
Unset element.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$key`: `\TKey`
|
||||
* `$key`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `TKey`
|
||||
|
||||
|
||||
|
||||
|
||||
### `set(\TKey $key, \TValue $value): void`
|
||||
### <a name="set"></a> `set(TKey $key, TValue $value): void`
|
||||
|
||||
Set element.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$key`: `\TKey`
|
||||
* `$value`: `\TValue`
|
||||
* `$key`: `TKey`
|
||||
* `$value`: `TValue`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `\TValue`
|
||||
* `TKey`
|
||||
* `TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
### `get(\TKey $key): ?\TValue`
|
||||
### <a name="get"></a> `get(TKey $key): ?TValue`
|
||||
|
||||
Get element.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$key`: `\TKey`
|
||||
* `$key`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `\TValue`
|
||||
* `TKey`
|
||||
* `TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
### `clear(): void`
|
||||
### <a name="clear"></a> `clear(): void`
|
||||
|
||||
Clear all elements.
|
||||
|
||||
|
||||
|
||||
### `getInstance(\danog\AsyncOrm\DbArrayBuilder $config, ?self $previous): self`
|
||||
### <a name="getInstance"></a> `getInstance(\danog\AsyncOrm\DbArrayBuilder $config, (\danog\AsyncOrm\DbArray<TTKey, TValue>|null) $previous): \danog\AsyncOrm\DbArray<TTKey, TValue>`
|
||||
|
||||
Get instance.
|
||||
|
||||
@ -185,22 +185,24 @@ Get instance.
|
||||
Parameters:
|
||||
|
||||
* `$config`: `\danog\AsyncOrm\DbArrayBuilder`
|
||||
* `$previous`: `?self`
|
||||
* `$previous`: `(\danog\AsyncOrm\DbArray<TTKey, TValue>|null)`
|
||||
|
||||
|
||||
#### See also:
|
||||
* [`\danog\AsyncOrm\DbArrayBuilder`: Contains configuration needed to build a DbArray.](../../danog/AsyncOrm/DbArrayBuilder.md)
|
||||
* `TTKey`
|
||||
* `TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
### `count(): mixed`
|
||||
### <a name="count"></a> `count()`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### `getIterator(): mixed`
|
||||
### <a name="getIterator"></a> `getIterator()`
|
||||
|
||||
|
||||
|
||||
|
@ -16,16 +16,16 @@ Contains configuration needed to build a DbArray.
|
||||
|
||||
## Properties
|
||||
* `$table`: `string` Table name.
|
||||
* `$settings`: `\danog\AsyncOrm\Settings` Settings.
|
||||
* `$keyType`: `\danog\AsyncOrm\KeyType` Key type.
|
||||
* `$valueType`: `\danog\AsyncOrm\ValueType` Value type.
|
||||
* `$settings`: `danog\AsyncOrm\Settings` Settings.
|
||||
* `$keyType`: `danog\AsyncOrm\KeyType` Key type.
|
||||
* `$valueType`: `danog\AsyncOrm\ValueType` Value type.
|
||||
|
||||
## Method list:
|
||||
* [`__construct(string $table, \danog\AsyncOrm\Settings $settings, \danog\AsyncOrm\KeyType $keyType, \danog\AsyncOrm\ValueType $valueType)`](#__construct-string-table-danog-asyncorm-settings-settings-danog-asyncorm-keytype-keytype-danog-asyncorm-valuetype-valuetype)
|
||||
* [`build(?\danog\AsyncOrm\DbArray $previous = NULL): \danog\AsyncOrm\DbArray`](#build-danog-asyncorm-dbarray-previous-null-danog-asyncorm-dbarray)
|
||||
* [`__construct(string $table, \danog\AsyncOrm\Settings $settings, \danog\AsyncOrm\KeyType $keyType, \danog\AsyncOrm\ValueType $valueType)`](#__construct)
|
||||
* [`build((\danog\AsyncOrm\DbArray<TKey, TValue>|null) $previous = NULL): \danog\AsyncOrm\DbArray<TKey, TValue>`](#build)
|
||||
|
||||
## Methods:
|
||||
### `__construct(string $table, \danog\AsyncOrm\Settings $settings, \danog\AsyncOrm\KeyType $keyType, \danog\AsyncOrm\ValueType $valueType)`
|
||||
### <a name="__construct"></a> `__construct(string $table, \danog\AsyncOrm\Settings $settings, \danog\AsyncOrm\KeyType $keyType, \danog\AsyncOrm\ValueType $valueType)`
|
||||
|
||||
|
||||
|
||||
@ -46,17 +46,19 @@ Parameters:
|
||||
|
||||
|
||||
|
||||
### `build(?\danog\AsyncOrm\DbArray $previous = NULL): \danog\AsyncOrm\DbArray`
|
||||
### <a name="build"></a> `build((\danog\AsyncOrm\DbArray<TKey, TValue>|null) $previous = NULL): \danog\AsyncOrm\DbArray<TKey, TValue>`
|
||||
|
||||
Build database array.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$previous`: `?\danog\AsyncOrm\DbArray`
|
||||
* `$previous`: `(\danog\AsyncOrm\DbArray<TKey, TValue>|null)`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `TKey`
|
||||
* `TValue`
|
||||
* [`\danog\AsyncOrm\DbArray`: DB array interface.](../../danog/AsyncOrm/DbArray.md)
|
||||
|
||||
|
||||
|
@ -16,11 +16,11 @@ Trait that provides autoconfiguration of OrmMappedArray properties.
|
||||
|
||||
|
||||
## Method list:
|
||||
* [`initDbProperties(\danog\AsyncOrm\Settings $settings, string $tablePrefix): void`](#initdbproperties-danog-asyncorm-settings-settings-string-tableprefix-void)
|
||||
* [`saveDbProperties(): void`](#savedbproperties-void)
|
||||
* [`initDbProperties(\danog\AsyncOrm\Settings $settings, string $tablePrefix): void`](#initDbProperties)
|
||||
* [`saveDbProperties(): void`](#saveDbProperties)
|
||||
|
||||
## Methods:
|
||||
### `initDbProperties(\danog\AsyncOrm\Settings $settings, string $tablePrefix): void`
|
||||
### <a name="initDbProperties"></a> `initDbProperties(\danog\AsyncOrm\Settings $settings, string $tablePrefix): void`
|
||||
|
||||
Initialize database properties.
|
||||
|
||||
@ -37,7 +37,7 @@ Parameters:
|
||||
|
||||
|
||||
|
||||
### `saveDbProperties(): void`
|
||||
### <a name="saveDbProperties"></a> `saveDbProperties(): void`
|
||||
|
||||
Save all properties.
|
||||
|
||||
|
@ -16,10 +16,10 @@ description: ""
|
||||
|
||||
|
||||
## Method list:
|
||||
* [`save(): void`](#save-void)
|
||||
* [`save(): void`](#save)
|
||||
|
||||
## Methods:
|
||||
### `save(): void`
|
||||
### <a name="save"></a> `save(): void`
|
||||
|
||||
Save object to database.
|
||||
|
||||
|
@ -16,22 +16,22 @@ Base class for driver-based arrays.
|
||||
|
||||
|
||||
## Method list:
|
||||
* [`getInstance(\danog\AsyncOrm\DbArrayBuilder $config, ?\danog\AsyncOrm\DbArray $previous): \danog\AsyncOrm\DbArray`](#getinstance-danog-asyncorm-dbarraybuilder-config-danog-asyncorm-dbarray-previous-danog-asyncorm-dbarray)
|
||||
* [`isset(\TKey $key): bool`](#isset-tkey-key-bool)
|
||||
* [`offsetGet(\TKey $offset): \TValue`](#offsetget-tkey-offset-tvalue)
|
||||
* [`offsetExists(\TKey $offset): bool`](#offsetexists-tkey-offset-bool)
|
||||
* [`offsetSet(\TKey $offset, \TValue $value): void`](#offsetset-tkey-offset-tvalue-value-void)
|
||||
* [`offsetUnset(\TKey $offset): void`](#offsetunset-tkey-offset-void)
|
||||
* [`getArrayCopy(): array`](#getarraycopy-array)
|
||||
* [`unset(\TKey $key): void`](#unset-tkey-key-void)
|
||||
* [`set(\TKey $key, \TValue $value): void`](#set-tkey-key-tvalue-value-void)
|
||||
* [`get(\TKey $key): ?\TValue`](#get-tkey-key-tvalue)
|
||||
* [`clear(): void`](#clear-void)
|
||||
* [`count(): mixed`](#count-mixed)
|
||||
* [`getIterator(): mixed`](#getiterator-mixed)
|
||||
* [`getInstance(\danog\AsyncOrm\DbArrayBuilder $config, \danog\AsyncOrm\DbArray<TTKey, TTValue> $previous): \danog\AsyncOrm\DbArray<TTKey, TTValue>`](#getInstance)
|
||||
* [`isset(TKey $key): bool`](#isset)
|
||||
* [`offsetGet(TKey $offset): TValue`](#offsetGet)
|
||||
* [`offsetExists(TKey $offset): bool`](#offsetExists)
|
||||
* [`offsetSet(TKey $offset, TValue $value): void`](#offsetSet)
|
||||
* [`offsetUnset(TKey $offset): void`](#offsetUnset)
|
||||
* [`getArrayCopy(): array`](#getArrayCopy)
|
||||
* [`unset(TKey $key): void`](#unset)
|
||||
* [`set(TKey $key, TValue $value): void`](#set)
|
||||
* [`get(TKey $key): ?TValue`](#get)
|
||||
* [`clear(): void`](#clear)
|
||||
* [`count()`](#count)
|
||||
* [`getIterator()`](#getIterator)
|
||||
|
||||
## Methods:
|
||||
### `getInstance(\danog\AsyncOrm\DbArrayBuilder $config, ?\danog\AsyncOrm\DbArray $previous): \danog\AsyncOrm\DbArray`
|
||||
### <a name="getInstance"></a> `getInstance(\danog\AsyncOrm\DbArrayBuilder $config, \danog\AsyncOrm\DbArray<TTKey, TTValue> $previous): \danog\AsyncOrm\DbArray<TTKey, TTValue>`
|
||||
|
||||
|
||||
|
||||
@ -39,169 +39,171 @@ Base class for driver-based arrays.
|
||||
Parameters:
|
||||
|
||||
* `$config`: `\danog\AsyncOrm\DbArrayBuilder`
|
||||
* `$previous`: `?\danog\AsyncOrm\DbArray`
|
||||
* `$previous`: `\danog\AsyncOrm\DbArray<TTKey, TTValue>`
|
||||
|
||||
|
||||
#### See also:
|
||||
* [`\danog\AsyncOrm\DbArrayBuilder`: Contains configuration needed to build a DbArray.](../../../danog/AsyncOrm/DbArrayBuilder.md)
|
||||
* `TTKey`
|
||||
* `TTValue`
|
||||
* [`\danog\AsyncOrm\DbArray`: DB array interface.](../../../danog/AsyncOrm/DbArray.md)
|
||||
|
||||
|
||||
|
||||
|
||||
### `isset(\TKey $key): bool`
|
||||
### <a name="isset"></a> `isset(TKey $key): bool`
|
||||
|
||||
Check if element exists.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$key`: `\TKey`
|
||||
* `$key`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `TKey`
|
||||
|
||||
|
||||
|
||||
|
||||
### `offsetGet(\TKey $offset): \TValue`
|
||||
### <a name="offsetGet"></a> `offsetGet(TKey $offset): TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$offset`: `\TKey`
|
||||
* `$offset`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `\TValue`
|
||||
* `TKey`
|
||||
* `TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
### `offsetExists(\TKey $offset): bool`
|
||||
### <a name="offsetExists"></a> `offsetExists(TKey $offset): bool`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$offset`: `\TKey`
|
||||
* `$offset`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `TKey`
|
||||
|
||||
|
||||
|
||||
|
||||
### `offsetSet(\TKey $offset, \TValue $value): void`
|
||||
### <a name="offsetSet"></a> `offsetSet(TKey $offset, TValue $value): void`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$offset`: `\TKey`
|
||||
* `$value`: `\TValue`
|
||||
* `$offset`: `TKey`
|
||||
* `$value`: `TValue`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `\TValue`
|
||||
* `TKey`
|
||||
* `TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
### `offsetUnset(\TKey $offset): void`
|
||||
### <a name="offsetUnset"></a> `offsetUnset(TKey $offset): void`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$offset`: `\TKey`
|
||||
* `$offset`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `TKey`
|
||||
|
||||
|
||||
|
||||
|
||||
### `getArrayCopy(): array`
|
||||
### <a name="getArrayCopy"></a> `getArrayCopy(): array`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### `unset(\TKey $key): void`
|
||||
### <a name="unset"></a> `unset(TKey $key): void`
|
||||
|
||||
Unset element.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$key`: `\TKey`
|
||||
* `$key`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `TKey`
|
||||
|
||||
|
||||
|
||||
|
||||
### `set(\TKey $key, \TValue $value): void`
|
||||
### <a name="set"></a> `set(TKey $key, TValue $value): void`
|
||||
|
||||
Set element.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$key`: `\TKey`
|
||||
* `$value`: `\TValue`
|
||||
* `$key`: `TKey`
|
||||
* `$value`: `TValue`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `\TValue`
|
||||
* `TKey`
|
||||
* `TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
### `get(\TKey $key): ?\TValue`
|
||||
### <a name="get"></a> `get(TKey $key): ?TValue`
|
||||
|
||||
Get element.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$key`: `\TKey`
|
||||
* `$key`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `\TValue`
|
||||
* `TKey`
|
||||
* `TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
### `clear(): void`
|
||||
### <a name="clear"></a> `clear(): void`
|
||||
|
||||
Clear all elements.
|
||||
|
||||
|
||||
|
||||
### `count(): mixed`
|
||||
### <a name="count"></a> `count()`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### `getIterator(): mixed`
|
||||
### <a name="getIterator"></a> `getIterator()`
|
||||
|
||||
|
||||
|
||||
|
@ -16,23 +16,23 @@ Memory database backend.
|
||||
|
||||
|
||||
## Method list:
|
||||
* [`__construct(array $data)`](#__construct-array-data)
|
||||
* [`getInstance(\danog\AsyncOrm\DbArrayBuilder $config, ?\danog\AsyncOrm\DbArray $previous): \danog\AsyncOrm\DbArray`](#getinstance-danog-asyncorm-dbarraybuilder-config-danog-asyncorm-dbarray-previous-danog-asyncorm-dbarray)
|
||||
* [`set(string|int $key, mixed $value): void`](#set-string-int-key-mixed-value-void)
|
||||
* [`get(string|int $key): mixed`](#get-string-int-key-mixed)
|
||||
* [`unset(string|int $key): void`](#unset-string-int-key-void)
|
||||
* [`clear(): void`](#clear-void)
|
||||
* [`count(): int`](#count-int)
|
||||
* [`getIterator(): \Traversable`](#getiterator-traversable)
|
||||
* [`getArrayCopy(): array`](#getarraycopy-array)
|
||||
* [`isset(\TKey $key): bool`](#isset-tkey-key-bool)
|
||||
* [`offsetGet(\TKey $offset): \TValue`](#offsetget-tkey-offset-tvalue)
|
||||
* [`offsetExists(\TKey $offset): bool`](#offsetexists-tkey-offset-bool)
|
||||
* [`offsetSet(\TKey $offset, \TValue $value): void`](#offsetset-tkey-offset-tvalue-value-void)
|
||||
* [`offsetUnset(\TKey $offset): void`](#offsetunset-tkey-offset-void)
|
||||
* [`__construct(array $data)`](#__construct)
|
||||
* [`getInstance(\danog\AsyncOrm\DbArrayBuilder $config, ?\danog\AsyncOrm\DbArray $previous): \danog\AsyncOrm\DbArray`](#getInstance)
|
||||
* [`set(string|int $key, mixed $value): void`](#set)
|
||||
* [`get(string|int $key): mixed`](#get)
|
||||
* [`unset(string|int $key): void`](#unset)
|
||||
* [`clear(): void`](#clear)
|
||||
* [`count(): int`](#count)
|
||||
* [`getIterator(): Traversable`](#getIterator)
|
||||
* [`getArrayCopy(): array`](#getArrayCopy)
|
||||
* [`isset(TKey $key): bool`](#isset)
|
||||
* [`offsetGet(TKey $offset): TValue`](#offsetGet)
|
||||
* [`offsetExists(TKey $offset): bool`](#offsetExists)
|
||||
* [`offsetSet(TKey $offset, TValue $value): void`](#offsetSet)
|
||||
* [`offsetUnset(TKey $offset): void`](#offsetUnset)
|
||||
|
||||
## Methods:
|
||||
### `__construct(array $data)`
|
||||
### <a name="__construct"></a> `__construct(array $data)`
|
||||
|
||||
|
||||
|
||||
@ -43,7 +43,7 @@ Parameters:
|
||||
|
||||
|
||||
|
||||
### `getInstance(\danog\AsyncOrm\DbArrayBuilder $config, ?\danog\AsyncOrm\DbArray $previous): \danog\AsyncOrm\DbArray`
|
||||
### <a name="getInstance"></a> `getInstance(\danog\AsyncOrm\DbArrayBuilder $config, ?\danog\AsyncOrm\DbArray $previous): \danog\AsyncOrm\DbArray`
|
||||
|
||||
|
||||
|
||||
@ -61,7 +61,7 @@ Parameters:
|
||||
|
||||
|
||||
|
||||
### `set(string|int $key, mixed $value): void`
|
||||
### <a name="set"></a> `set(string|int $key, mixed $value): void`
|
||||
|
||||
|
||||
|
||||
@ -73,7 +73,7 @@ Parameters:
|
||||
|
||||
|
||||
|
||||
### `get(string|int $key): mixed`
|
||||
### <a name="get"></a> `get(string|int $key): mixed`
|
||||
|
||||
|
||||
|
||||
@ -84,7 +84,7 @@ Parameters:
|
||||
|
||||
|
||||
|
||||
### `unset(string|int $key): void`
|
||||
### <a name="unset"></a> `unset(string|int $key): void`
|
||||
|
||||
|
||||
|
||||
@ -95,114 +95,114 @@ Parameters:
|
||||
|
||||
|
||||
|
||||
### `clear(): void`
|
||||
### <a name="clear"></a> `clear(): void`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### `count(): int`
|
||||
### <a name="count"></a> `count(): int`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### `getIterator(): \Traversable`
|
||||
### <a name="getIterator"></a> `getIterator(): Traversable`
|
||||
|
||||
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\Traversable`
|
||||
* `Traversable`
|
||||
|
||||
|
||||
|
||||
|
||||
### `getArrayCopy(): array`
|
||||
### <a name="getArrayCopy"></a> `getArrayCopy(): array`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### `isset(\TKey $key): bool`
|
||||
### <a name="isset"></a> `isset(TKey $key): bool`
|
||||
|
||||
Check if element exists.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$key`: `\TKey`
|
||||
* `$key`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `TKey`
|
||||
|
||||
|
||||
|
||||
|
||||
### `offsetGet(\TKey $offset): \TValue`
|
||||
### <a name="offsetGet"></a> `offsetGet(TKey $offset): TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$offset`: `\TKey`
|
||||
* `$offset`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `\TValue`
|
||||
* `TKey`
|
||||
* `TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
### `offsetExists(\TKey $offset): bool`
|
||||
### <a name="offsetExists"></a> `offsetExists(TKey $offset): bool`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$offset`: `\TKey`
|
||||
* `$offset`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `TKey`
|
||||
|
||||
|
||||
|
||||
|
||||
### `offsetSet(\TKey $offset, \TValue $value): void`
|
||||
### <a name="offsetSet"></a> `offsetSet(TKey $offset, TValue $value): void`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$offset`: `\TKey`
|
||||
* `$value`: `\TValue`
|
||||
* `$offset`: `TKey`
|
||||
* `$value`: `TValue`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `\TValue`
|
||||
* `TKey`
|
||||
* `TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
### `offsetUnset(\TKey $offset): void`
|
||||
### <a name="offsetUnset"></a> `offsetUnset(TKey $offset): void`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$offset`: `\TKey`
|
||||
* `$offset`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `TKey`
|
||||
|
||||
|
||||
|
||||
|
@ -16,23 +16,22 @@ Generic SQL database backend.
|
||||
|
||||
|
||||
## Method list:
|
||||
* [`getIterator(): \Traversable<array-key, mixed>`](#getiterator-traversable-array-key-mixed)
|
||||
* [`get(mixed $key): mixed`](#get-mixed-key-mixed)
|
||||
* [`set(string|int $key, mixed $value): void`](#set-string-int-key-mixed-value-void)
|
||||
* [`unset(string|int $key): void`](#unset-string-int-key-void)
|
||||
* [`count(): \int The number of elements or public properties in the associated
|
||||
array or object, respectively.`](#count-int-the-number-of-elements-or-public-properties-in-the-associated-array-or-object-respectively)
|
||||
* [`clear(): void`](#clear-void)
|
||||
* [`getInstance(\danog\AsyncOrm\DbArrayBuilder $config, ?\danog\AsyncOrm\DbArray $previous): \danog\AsyncOrm\DbArray`](#getinstance-danog-asyncorm-dbarraybuilder-config-danog-asyncorm-dbarray-previous-danog-asyncorm-dbarray)
|
||||
* [`isset(\TKey $key): bool`](#isset-tkey-key-bool)
|
||||
* [`offsetGet(\TKey $offset): \TValue`](#offsetget-tkey-offset-tvalue)
|
||||
* [`offsetExists(\TKey $offset): bool`](#offsetexists-tkey-offset-bool)
|
||||
* [`offsetSet(\TKey $offset, \TValue $value): void`](#offsetset-tkey-offset-tvalue-value-void)
|
||||
* [`offsetUnset(\TKey $offset): void`](#offsetunset-tkey-offset-void)
|
||||
* [`getArrayCopy(): array`](#getarraycopy-array)
|
||||
* [`getIterator(): \Traversable<array-key, mixed>`](#getIterator)
|
||||
* [`get(mixed $key): mixed`](#get)
|
||||
* [`set(string|int $key, mixed $value): void`](#set)
|
||||
* [`unset(string|int $key): void`](#unset)
|
||||
* [`count(): int`](#count)
|
||||
* [`clear(): void`](#clear)
|
||||
* [`getInstance(\danog\AsyncOrm\DbArrayBuilder $config, \danog\AsyncOrm\DbArray<TTKey, TTValue> $previous): \danog\AsyncOrm\DbArray<TTKey, TTValue>`](#getInstance)
|
||||
* [`isset(TKey $key): bool`](#isset)
|
||||
* [`offsetGet(TKey $offset): TValue`](#offsetGet)
|
||||
* [`offsetExists(TKey $offset): bool`](#offsetExists)
|
||||
* [`offsetSet(TKey $offset, TValue $value): void`](#offsetSet)
|
||||
* [`offsetUnset(TKey $offset): void`](#offsetUnset)
|
||||
* [`getArrayCopy(): array`](#getArrayCopy)
|
||||
|
||||
## Methods:
|
||||
### `getIterator(): \Traversable<array-key, mixed>`
|
||||
### <a name="getIterator"></a> `getIterator(): \Traversable<array-key, mixed>`
|
||||
|
||||
Get iterator.
|
||||
|
||||
@ -43,7 +42,7 @@ Get iterator.
|
||||
|
||||
|
||||
|
||||
### `get(mixed $key): mixed`
|
||||
### <a name="get"></a> `get(mixed $key): mixed`
|
||||
|
||||
|
||||
|
||||
@ -54,7 +53,7 @@ Parameters:
|
||||
|
||||
|
||||
|
||||
### `set(string|int $key, mixed $value): void`
|
||||
### <a name="set"></a> `set(string|int $key, mixed $value): void`
|
||||
|
||||
|
||||
|
||||
@ -66,7 +65,7 @@ Parameters:
|
||||
|
||||
|
||||
|
||||
### `unset(string|int $key): void`
|
||||
### <a name="unset"></a> `unset(string|int $key): void`
|
||||
|
||||
Unset value for an offset.
|
||||
|
||||
@ -77,8 +76,7 @@ Parameters:
|
||||
|
||||
|
||||
|
||||
### `count(): \int The number of elements or public properties in the associated
|
||||
array or object, respectively.`
|
||||
### <a name="count"></a> `count(): int`
|
||||
|
||||
Count elements.
|
||||
|
||||
@ -87,13 +85,13 @@ Return value: The number of elements or public properties in the associated
|
||||
array or object, respectively.
|
||||
|
||||
|
||||
### `clear(): void`
|
||||
### <a name="clear"></a> `clear(): void`
|
||||
|
||||
Clear all elements.
|
||||
|
||||
|
||||
|
||||
### `getInstance(\danog\AsyncOrm\DbArrayBuilder $config, ?\danog\AsyncOrm\DbArray $previous): \danog\AsyncOrm\DbArray`
|
||||
### <a name="getInstance"></a> `getInstance(\danog\AsyncOrm\DbArrayBuilder $config, \danog\AsyncOrm\DbArray<TTKey, TTValue> $previous): \danog\AsyncOrm\DbArray<TTKey, TTValue>`
|
||||
|
||||
|
||||
|
||||
@ -101,100 +99,102 @@ Clear all elements.
|
||||
Parameters:
|
||||
|
||||
* `$config`: `\danog\AsyncOrm\DbArrayBuilder`
|
||||
* `$previous`: `?\danog\AsyncOrm\DbArray`
|
||||
* `$previous`: `\danog\AsyncOrm\DbArray<TTKey, TTValue>`
|
||||
|
||||
|
||||
#### See also:
|
||||
* [`\danog\AsyncOrm\DbArrayBuilder`: Contains configuration needed to build a DbArray.](../../../danog/AsyncOrm/DbArrayBuilder.md)
|
||||
* `TTKey`
|
||||
* `TTValue`
|
||||
* [`\danog\AsyncOrm\DbArray`: DB array interface.](../../../danog/AsyncOrm/DbArray.md)
|
||||
|
||||
|
||||
|
||||
|
||||
### `isset(\TKey $key): bool`
|
||||
### <a name="isset"></a> `isset(TKey $key): bool`
|
||||
|
||||
Check if element exists.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$key`: `\TKey`
|
||||
* `$key`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `TKey`
|
||||
|
||||
|
||||
|
||||
|
||||
### `offsetGet(\TKey $offset): \TValue`
|
||||
### <a name="offsetGet"></a> `offsetGet(TKey $offset): TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$offset`: `\TKey`
|
||||
* `$offset`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `\TValue`
|
||||
* `TKey`
|
||||
* `TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
### `offsetExists(\TKey $offset): bool`
|
||||
### <a name="offsetExists"></a> `offsetExists(TKey $offset): bool`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$offset`: `\TKey`
|
||||
* `$offset`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `TKey`
|
||||
|
||||
|
||||
|
||||
|
||||
### `offsetSet(\TKey $offset, \TValue $value): void`
|
||||
### <a name="offsetSet"></a> `offsetSet(TKey $offset, TValue $value): void`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$offset`: `\TKey`
|
||||
* `$value`: `\TValue`
|
||||
* `$offset`: `TKey`
|
||||
* `$value`: `TValue`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `\TValue`
|
||||
* `TKey`
|
||||
* `TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
### `offsetUnset(\TKey $offset): void`
|
||||
### <a name="offsetUnset"></a> `offsetUnset(TKey $offset): void`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$offset`: `\TKey`
|
||||
* `$offset`: `TKey`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TKey`
|
||||
* `TKey`
|
||||
|
||||
|
||||
|
||||
|
||||
### `getArrayCopy(): array`
|
||||
### <a name="getArrayCopy"></a> `getArrayCopy(): array`
|
||||
|
||||
|
||||
|
||||
|
@ -27,18 +27,18 @@ Specifies the type of keys.
|
||||
* `$value`: `string`
|
||||
|
||||
## Method list:
|
||||
* [`cases(): array`](#cases-array)
|
||||
* [`from(string|int $value): static`](#from-string-int-value-static)
|
||||
* [`tryFrom(string|int $value): ?static`](#tryfrom-string-int-value-static)
|
||||
* [`cases(): array`](#cases)
|
||||
* [`from(string|int $value): static`](#from)
|
||||
* [`tryFrom(string|int $value): ?static`](#tryFrom)
|
||||
|
||||
## Methods:
|
||||
### `cases(): array`
|
||||
### <a name="cases"></a> `cases(): array`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### `from(string|int $value): static`
|
||||
### <a name="from"></a> `from(string|int $value): static`
|
||||
|
||||
|
||||
|
||||
@ -49,7 +49,7 @@ Parameters:
|
||||
|
||||
|
||||
|
||||
### `tryFrom(string|int $value): ?static`
|
||||
### <a name="tryFrom"></a> `tryFrom(string|int $value): ?static`
|
||||
|
||||
|
||||
|
||||
|
@ -16,27 +16,27 @@ Serializer interface.
|
||||
|
||||
|
||||
## Method list:
|
||||
* [`serialize(\TValue $value): mixed`](#serialize-tvalue-value-mixed)
|
||||
* [`deserialize(mixed $value): \TValue`](#deserialize-mixed-value-tvalue)
|
||||
* [`serialize(TValue $value): mixed`](#serialize)
|
||||
* [`deserialize(mixed $value): TValue`](#deserialize)
|
||||
|
||||
## Methods:
|
||||
### `serialize(\TValue $value): mixed`
|
||||
### <a name="serialize"></a> `serialize(TValue $value): mixed`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$value`: `\TValue`
|
||||
* `$value`: `TValue`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TValue`
|
||||
* `TValue`
|
||||
|
||||
|
||||
|
||||
|
||||
### `deserialize(mixed $value): \TValue`
|
||||
### <a name="deserialize"></a> `deserialize(mixed $value): TValue`
|
||||
|
||||
|
||||
|
||||
@ -47,7 +47,7 @@ Parameters:
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\TValue`
|
||||
* `TValue`
|
||||
|
||||
|
||||
|
||||
|
@ -16,11 +16,11 @@ Igbinary serializer.
|
||||
|
||||
|
||||
## Method list:
|
||||
* [`serialize(mixed $value): mixed`](#serialize-mixed-value-mixed)
|
||||
* [`deserialize(mixed $value): mixed`](#deserialize-mixed-value-mixed)
|
||||
* [`serialize(mixed $value): mixed`](#serialize)
|
||||
* [`deserialize(mixed $value): mixed`](#deserialize)
|
||||
|
||||
## Methods:
|
||||
### `serialize(mixed $value): mixed`
|
||||
### <a name="serialize"></a> `serialize(mixed $value): mixed`
|
||||
|
||||
|
||||
|
||||
@ -31,7 +31,7 @@ Parameters:
|
||||
|
||||
|
||||
|
||||
### `deserialize(mixed $value): mixed`
|
||||
### <a name="deserialize"></a> `deserialize(mixed $value): mixed`
|
||||
|
||||
|
||||
|
||||
|
@ -16,11 +16,11 @@ JSON serializer.
|
||||
|
||||
|
||||
## Method list:
|
||||
* [`serialize(mixed $value): mixed`](#serialize-mixed-value-mixed)
|
||||
* [`deserialize(mixed $value): mixed`](#deserialize-mixed-value-mixed)
|
||||
* [`serialize(mixed $value): mixed`](#serialize)
|
||||
* [`deserialize(mixed $value): mixed`](#deserialize)
|
||||
|
||||
## Methods:
|
||||
### `serialize(mixed $value): mixed`
|
||||
### <a name="serialize"></a> `serialize(mixed $value): mixed`
|
||||
|
||||
|
||||
|
||||
@ -31,7 +31,7 @@ Parameters:
|
||||
|
||||
|
||||
|
||||
### `deserialize(mixed $value): mixed`
|
||||
### <a name="deserialize"></a> `deserialize(mixed $value): mixed`
|
||||
|
||||
|
||||
|
||||
|
@ -16,11 +16,11 @@ Native serializer.
|
||||
|
||||
|
||||
## Method list:
|
||||
* [`serialize(mixed $value): mixed`](#serialize-mixed-value-mixed)
|
||||
* [`deserialize(mixed $value): mixed`](#deserialize-mixed-value-mixed)
|
||||
* [`serialize(mixed $value): mixed`](#serialize)
|
||||
* [`deserialize(mixed $value): mixed`](#deserialize)
|
||||
|
||||
## Methods:
|
||||
### `serialize(mixed $value): mixed`
|
||||
### <a name="serialize"></a> `serialize(mixed $value): mixed`
|
||||
|
||||
|
||||
|
||||
@ -31,7 +31,7 @@ Parameters:
|
||||
|
||||
|
||||
|
||||
### `deserialize(mixed $value): mixed`
|
||||
### <a name="deserialize"></a> `deserialize(mixed $value): mixed`
|
||||
|
||||
|
||||
|
||||
|
@ -16,10 +16,10 @@ Base interface for ORM settings.
|
||||
|
||||
|
||||
## Method list:
|
||||
* [`getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`](#getdriverclass-class-string-danog-asyncorm-dbarray)
|
||||
* [`getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`](#getDriverClass)
|
||||
|
||||
## Methods:
|
||||
### `getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`
|
||||
### <a name="getDriverClass"></a> `getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`
|
||||
|
||||
|
||||
|
||||
|
@ -19,15 +19,15 @@ Base settings class for database backends.
|
||||
* `danog\AsyncOrm\Settings\DriverSettings::DEFAULT_CACHE_TTL`:
|
||||
|
||||
## Properties
|
||||
* `$serializer`: `\danog\AsyncOrm\Serializer`
|
||||
* `$serializer`: `danog\AsyncOrm\Serializer`
|
||||
* `$cacheTtl`: `int<0, max>` For how long to keep records in memory after last read.
|
||||
|
||||
## Method list:
|
||||
* [`__construct(?\danog\AsyncOrm\Serializer $serializer = NULL, int $cacheTtl = \self::DEFAULT_CACHE_TTL)`](#__construct-danog-asyncorm-serializer-serializer-null-int-cachettl-self-default_cache_ttl)
|
||||
* [`getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`](#getdriverclass-class-string-danog-asyncorm-dbarray)
|
||||
* [`__construct(?\danog\AsyncOrm\Serializer $serializer = NULL, int $cacheTtl = \self::DEFAULT_CACHE_TTL)`](#__construct)
|
||||
* [`getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`](#getDriverClass)
|
||||
|
||||
## Methods:
|
||||
### `__construct(?\danog\AsyncOrm\Serializer $serializer = NULL, int $cacheTtl = \self::DEFAULT_CACHE_TTL)`
|
||||
### <a name="__construct"></a> `__construct(?\danog\AsyncOrm\Serializer $serializer = NULL, int $cacheTtl = \self::DEFAULT_CACHE_TTL)`
|
||||
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ Parameters:
|
||||
|
||||
|
||||
|
||||
### `getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`
|
||||
### <a name="getDriverClass"></a> `getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`
|
||||
|
||||
|
||||
|
||||
|
@ -16,10 +16,10 @@ MemorySettings backend settings.
|
||||
|
||||
|
||||
## Method list:
|
||||
* [`getDriverClass(): string`](#getdriverclass-string)
|
||||
* [`getDriverClass(): string`](#getDriverClass)
|
||||
|
||||
## Methods:
|
||||
### `getDriverClass(): string`
|
||||
### <a name="getDriverClass"></a> `getDriverClass(): string`
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "danog\\AsyncOrm\\Settings\\MysqlSettings: MySQL backend settings."
|
||||
description: "MariaDb 10.2+ or Mysql 5.6+ required."
|
||||
description: "\nMariaDb 10.2+ or Mysql 5.6+ required.\n"
|
||||
|
||||
---
|
||||
# `danog\AsyncOrm\Settings\MysqlSettings`
|
||||
@ -12,9 +12,11 @@ description: "MariaDb 10.2+ or Mysql 5.6+ required."
|
||||
|
||||
MySQL backend settings.
|
||||
|
||||
|
||||
MariaDb 10.2+ or Mysql 5.6+ required.
|
||||
|
||||
|
||||
|
||||
## Constants
|
||||
* `danog\AsyncOrm\Settings\MysqlSettings::DEFAULT_SQL_MAX_CONNECTIONS`:
|
||||
|
||||
@ -23,19 +25,24 @@ MariaDb 10.2+ or Mysql 5.6+ required.
|
||||
* `danog\AsyncOrm\Settings\MysqlSettings::DEFAULT_CACHE_TTL`:
|
||||
|
||||
## Properties
|
||||
* `$optimizeIfWastedMb`: `int<1, max>|null`
|
||||
* `$maxConnections`: `positive-int`
|
||||
* `$idleTimeout`: `positive-int`
|
||||
* `$config`: `\T`
|
||||
* `$serializer`: `\danog\AsyncOrm\Serializer`
|
||||
* `$optimizeIfWastedMb`: `(int<1, max> | null)`
|
||||
Whether to optimize MySQL tables automatically if more than the specified amount of megabytes is wasted by the MySQL engine.
|
||||
|
||||
Be careful when tweaking this setting as it may lead to slowdowns on startup.
|
||||
|
||||
If null disables optimization.
|
||||
* `$maxConnections`: `positive-int` Maximum connection limit.
|
||||
* `$idleTimeout`: `positive-int` Idle timeout.
|
||||
* `$config`: `T`
|
||||
* `$serializer`: `danog\AsyncOrm\Serializer`
|
||||
* `$cacheTtl`: `int<0, max>` For how long to keep records in memory after last read.
|
||||
|
||||
## Method list:
|
||||
* [`__construct(\Amp\Mysql\MysqlConfig $config, ?\danog\AsyncOrm\Serializer $serializer = NULL, int<\0, \max> $cacheTtl = \self::DEFAULT_CACHE_TTL, int<\1, \max> $maxConnections = \self::DEFAULT_SQL_MAX_CONNECTIONS, int<\1, \max> $idleTimeout = \self::DEFAULT_SQL_IDLE_TIMEOUT, ?int $optimizeIfWastedMb = NULL)`](#__construct-amp-mysql-mysqlconfig-config-danog-asyncorm-serializer-serializer-null-int-0-max-cachettl-self-default_cache_ttl-int-1-max-maxconnections-self-default_sql_max_connections-int-1-max-idletimeout-self-default_sql_idle_timeout-int-optimizeifwastedmb-null)
|
||||
* [`getDriverClass(): string`](#getdriverclass-string)
|
||||
* [`__construct(\Amp\Mysql\MysqlConfig $config, ?\danog\AsyncOrm\Serializer $serializer = NULL, int<0, max> $cacheTtl = \self::DEFAULT_CACHE_TTL, int<1, max> $maxConnections = \self::DEFAULT_SQL_MAX_CONNECTIONS, int<1, max> $idleTimeout = \self::DEFAULT_SQL_IDLE_TIMEOUT, ?int $optimizeIfWastedMb = NULL)`](#__construct)
|
||||
* [`getDriverClass(): string`](#getDriverClass)
|
||||
|
||||
## Methods:
|
||||
### `__construct(\Amp\Mysql\MysqlConfig $config, ?\danog\AsyncOrm\Serializer $serializer = NULL, int<\0, \max> $cacheTtl = \self::DEFAULT_CACHE_TTL, int<\1, \max> $maxConnections = \self::DEFAULT_SQL_MAX_CONNECTIONS, int<\1, \max> $idleTimeout = \self::DEFAULT_SQL_IDLE_TIMEOUT, ?int $optimizeIfWastedMb = NULL)`
|
||||
### <a name="__construct"></a> `__construct(\Amp\Mysql\MysqlConfig $config, ?\danog\AsyncOrm\Serializer $serializer = NULL, int<0, max> $cacheTtl = \self::DEFAULT_CACHE_TTL, int<1, max> $maxConnections = \self::DEFAULT_SQL_MAX_CONNECTIONS, int<1, max> $idleTimeout = \self::DEFAULT_SQL_IDLE_TIMEOUT, ?int $optimizeIfWastedMb = NULL)`
|
||||
|
||||
|
||||
|
||||
@ -44,21 +51,21 @@ Parameters:
|
||||
|
||||
* `$config`: `\Amp\Mysql\MysqlConfig`
|
||||
* `$serializer`: `?\danog\AsyncOrm\Serializer` to use for object and mixed type values, if null defaults to either Igbinary or Native.
|
||||
* `$cacheTtl`: `int<\0, \max>` Cache TTL in seconds, if 0 disables caching.
|
||||
* `$maxConnections`: `int<\1, \max>` Maximum connection limit
|
||||
* `$idleTimeout`: `int<\1, \max>` Idle timeout
|
||||
* `$cacheTtl`: `int<0, max>` Cache TTL in seconds, if 0 disables caching.
|
||||
* `$maxConnections`: `int<1, max>` Maximum connection limit
|
||||
* `$idleTimeout`: `int<1, max>` Idle timeout
|
||||
* `$optimizeIfWastedMb`: `?int`
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\Amp\Mysql\MysqlConfig`
|
||||
* [`\danog\AsyncOrm\Serializer`: Serializer interface.](../../../danog/AsyncOrm/Serializer.md)
|
||||
* `\max`
|
||||
* `max`
|
||||
|
||||
|
||||
|
||||
|
||||
### `getDriverClass(): string`
|
||||
### <a name="getDriverClass"></a> `getDriverClass(): string`
|
||||
|
||||
|
||||
|
||||
|
@ -23,18 +23,18 @@ Postgres backend settings.
|
||||
* `danog\AsyncOrm\Settings\PostgresSettings::DEFAULT_CACHE_TTL`:
|
||||
|
||||
## Properties
|
||||
* `$maxConnections`: `positive-int`
|
||||
* `$idleTimeout`: `positive-int`
|
||||
* `$config`: `\T`
|
||||
* `$serializer`: `\danog\AsyncOrm\Serializer`
|
||||
* `$maxConnections`: `positive-int` Maximum connection limit.
|
||||
* `$idleTimeout`: `positive-int` Idle timeout.
|
||||
* `$config`: `T`
|
||||
* `$serializer`: `danog\AsyncOrm\Serializer`
|
||||
* `$cacheTtl`: `int<0, max>` For how long to keep records in memory after last read.
|
||||
|
||||
## Method list:
|
||||
* [`__construct(\Amp\Postgres\PostgresConfig $config, ?\danog\AsyncOrm\Serializer $serializer = NULL, int<\0, \max> $cacheTtl = \self::DEFAULT_CACHE_TTL, int<\1, \max> $maxConnections = \self::DEFAULT_SQL_MAX_CONNECTIONS, int<\1, \max> $idleTimeout = \self::DEFAULT_SQL_IDLE_TIMEOUT)`](#__construct-amp-postgres-postgresconfig-config-danog-asyncorm-serializer-serializer-null-int-0-max-cachettl-self-default_cache_ttl-int-1-max-maxconnections-self-default_sql_max_connections-int-1-max-idletimeout-self-default_sql_idle_timeout)
|
||||
* [`getDriverClass(): string`](#getdriverclass-string)
|
||||
* [`__construct(\Amp\Postgres\PostgresConfig $config, ?\danog\AsyncOrm\Serializer $serializer = NULL, int<0, max> $cacheTtl = \self::DEFAULT_CACHE_TTL, int<1, max> $maxConnections = \self::DEFAULT_SQL_MAX_CONNECTIONS, int<1, max> $idleTimeout = \self::DEFAULT_SQL_IDLE_TIMEOUT)`](#__construct)
|
||||
* [`getDriverClass(): string`](#getDriverClass)
|
||||
|
||||
## Methods:
|
||||
### `__construct(\Amp\Postgres\PostgresConfig $config, ?\danog\AsyncOrm\Serializer $serializer = NULL, int<\0, \max> $cacheTtl = \self::DEFAULT_CACHE_TTL, int<\1, \max> $maxConnections = \self::DEFAULT_SQL_MAX_CONNECTIONS, int<\1, \max> $idleTimeout = \self::DEFAULT_SQL_IDLE_TIMEOUT)`
|
||||
### <a name="__construct"></a> `__construct(\Amp\Postgres\PostgresConfig $config, ?\danog\AsyncOrm\Serializer $serializer = NULL, int<0, max> $cacheTtl = \self::DEFAULT_CACHE_TTL, int<1, max> $maxConnections = \self::DEFAULT_SQL_MAX_CONNECTIONS, int<1, max> $idleTimeout = \self::DEFAULT_SQL_IDLE_TIMEOUT)`
|
||||
|
||||
|
||||
|
||||
@ -43,20 +43,20 @@ Parameters:
|
||||
|
||||
* `$config`: `\Amp\Postgres\PostgresConfig`
|
||||
* `$serializer`: `?\danog\AsyncOrm\Serializer` to use for object and mixed type values, if null defaults to either Igbinary or Native.
|
||||
* `$cacheTtl`: `int<\0, \max>` Cache TTL in seconds
|
||||
* `$maxConnections`: `int<\1, \max>` Maximum connection limit
|
||||
* `$idleTimeout`: `int<\1, \max>` Idle timeout
|
||||
* `$cacheTtl`: `int<0, max>` Cache TTL in seconds
|
||||
* `$maxConnections`: `int<1, max>` Maximum connection limit
|
||||
* `$idleTimeout`: `int<1, max>` Idle timeout
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\Amp\Postgres\PostgresConfig`
|
||||
* [`\danog\AsyncOrm\Serializer`: Serializer interface.](../../../danog/AsyncOrm/Serializer.md)
|
||||
* `\max`
|
||||
* `max`
|
||||
|
||||
|
||||
|
||||
|
||||
### `getDriverClass(): string`
|
||||
### <a name="getDriverClass"></a> `getDriverClass(): string`
|
||||
|
||||
|
||||
|
||||
|
@ -19,16 +19,16 @@ Redis backend settings.
|
||||
* `danog\AsyncOrm\Settings\RedisSettings::DEFAULT_CACHE_TTL`:
|
||||
|
||||
## Properties
|
||||
* `$config`: `\Amp\Redis\RedisConfig`
|
||||
* `$serializer`: `\danog\AsyncOrm\Serializer`
|
||||
* `$config`: `Amp\Redis\RedisConfig`
|
||||
* `$serializer`: `danog\AsyncOrm\Serializer`
|
||||
* `$cacheTtl`: `int<0, max>` For how long to keep records in memory after last read.
|
||||
|
||||
## Method list:
|
||||
* [`__construct(\Amp\Redis\RedisConfig $config, ?\danog\AsyncOrm\Serializer $serializer = NULL, int<\0, \max> $cacheTtl = \self::DEFAULT_CACHE_TTL)`](#__construct-amp-redis-redisconfig-config-danog-asyncorm-serializer-serializer-null-int-0-max-cachettl-self-default_cache_ttl)
|
||||
* [`getDriverClass(): string`](#getdriverclass-string)
|
||||
* [`__construct(\Amp\Redis\RedisConfig $config, ?\danog\AsyncOrm\Serializer $serializer = NULL, int<0, max> $cacheTtl = \self::DEFAULT_CACHE_TTL)`](#__construct)
|
||||
* [`getDriverClass(): string`](#getDriverClass)
|
||||
|
||||
## Methods:
|
||||
### `__construct(\Amp\Redis\RedisConfig $config, ?\danog\AsyncOrm\Serializer $serializer = NULL, int<\0, \max> $cacheTtl = \self::DEFAULT_CACHE_TTL)`
|
||||
### <a name="__construct"></a> `__construct(\Amp\Redis\RedisConfig $config, ?\danog\AsyncOrm\Serializer $serializer = NULL, int<0, max> $cacheTtl = \self::DEFAULT_CACHE_TTL)`
|
||||
|
||||
|
||||
|
||||
@ -37,18 +37,18 @@ Parameters:
|
||||
|
||||
* `$config`: `\Amp\Redis\RedisConfig`
|
||||
* `$serializer`: `?\danog\AsyncOrm\Serializer` to use for object and mixed type values, if null defaults to either Igbinary or Native.
|
||||
* `$cacheTtl`: `int<\0, \max>` Cache TTL in seconds
|
||||
* `$cacheTtl`: `int<0, max>` Cache TTL in seconds
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\Amp\Redis\RedisConfig`
|
||||
* [`\danog\AsyncOrm\Serializer`: Serializer interface.](../../../danog/AsyncOrm/Serializer.md)
|
||||
* `\max`
|
||||
* `max`
|
||||
|
||||
|
||||
|
||||
|
||||
### `getDriverClass(): string`
|
||||
### <a name="getDriverClass"></a> `getDriverClass(): string`
|
||||
|
||||
|
||||
|
||||
|
@ -23,18 +23,18 @@ Generic SQL db backend settings.
|
||||
* `danog\AsyncOrm\Settings\SqlSettings::DEFAULT_CACHE_TTL`:
|
||||
|
||||
## Properties
|
||||
* `$maxConnections`: `positive-int`
|
||||
* `$idleTimeout`: `positive-int`
|
||||
* `$config`: `\T`
|
||||
* `$serializer`: `\danog\AsyncOrm\Serializer`
|
||||
* `$maxConnections`: `positive-int` Maximum connection limit.
|
||||
* `$idleTimeout`: `positive-int` Idle timeout.
|
||||
* `$config`: `T`
|
||||
* `$serializer`: `danog\AsyncOrm\Serializer`
|
||||
* `$cacheTtl`: `int<0, max>` For how long to keep records in memory after last read.
|
||||
|
||||
## Method list:
|
||||
* [`__construct(\Amp\Sql\SqlConfig $config, ?\danog\AsyncOrm\Serializer $serializer, int<\0, \max> $cacheTtl = \self::DEFAULT_CACHE_TTL, int<\1, \max> $maxConnections = \self::DEFAULT_SQL_MAX_CONNECTIONS, int<\1, \max> $idleTimeout = \self::DEFAULT_SQL_IDLE_TIMEOUT)`](#__construct-amp-sql-sqlconfig-config-danog-asyncorm-serializer-serializer-int-0-max-cachettl-self-default_cache_ttl-int-1-max-maxconnections-self-default_sql_max_connections-int-1-max-idletimeout-self-default_sql_idle_timeout)
|
||||
* [`getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`](#getdriverclass-class-string-danog-asyncorm-dbarray)
|
||||
* [`__construct(\Amp\Sql\SqlConfig $config, ?\danog\AsyncOrm\Serializer $serializer, int<0, max> $cacheTtl = \self::DEFAULT_CACHE_TTL, int<1, max> $maxConnections = \self::DEFAULT_SQL_MAX_CONNECTIONS, int<1, max> $idleTimeout = \self::DEFAULT_SQL_IDLE_TIMEOUT)`](#__construct)
|
||||
* [`getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`](#getDriverClass)
|
||||
|
||||
## Methods:
|
||||
### `__construct(\Amp\Sql\SqlConfig $config, ?\danog\AsyncOrm\Serializer $serializer, int<\0, \max> $cacheTtl = \self::DEFAULT_CACHE_TTL, int<\1, \max> $maxConnections = \self::DEFAULT_SQL_MAX_CONNECTIONS, int<\1, \max> $idleTimeout = \self::DEFAULT_SQL_IDLE_TIMEOUT)`
|
||||
### <a name="__construct"></a> `__construct(\Amp\Sql\SqlConfig $config, ?\danog\AsyncOrm\Serializer $serializer, int<0, max> $cacheTtl = \self::DEFAULT_CACHE_TTL, int<1, max> $maxConnections = \self::DEFAULT_SQL_MAX_CONNECTIONS, int<1, max> $idleTimeout = \self::DEFAULT_SQL_IDLE_TIMEOUT)`
|
||||
|
||||
|
||||
|
||||
@ -43,20 +43,20 @@ Parameters:
|
||||
|
||||
* `$config`: `\Amp\Sql\SqlConfig`
|
||||
* `$serializer`: `?\danog\AsyncOrm\Serializer` to use for object and mixed type values.
|
||||
* `$cacheTtl`: `int<\0, \max>` Cache TTL in seconds
|
||||
* `$maxConnections`: `int<\1, \max>` Maximum connection limit
|
||||
* `$idleTimeout`: `int<\1, \max>` Idle timeout
|
||||
* `$cacheTtl`: `int<0, max>` Cache TTL in seconds
|
||||
* `$maxConnections`: `int<1, max>` Maximum connection limit
|
||||
* `$idleTimeout`: `int<1, max>` Idle timeout
|
||||
|
||||
|
||||
#### See also:
|
||||
* `\Amp\Sql\SqlConfig`
|
||||
* [`\danog\AsyncOrm\Serializer`: Serializer interface.](../../../danog/AsyncOrm/Serializer.md)
|
||||
* `\max`
|
||||
* `max`
|
||||
|
||||
|
||||
|
||||
|
||||
### `getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`
|
||||
### <a name="getDriverClass"></a> `getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`
|
||||
|
||||
|
||||
|
||||
|
@ -28,25 +28,25 @@ Specifies the serializer to use when saving values.
|
||||
|
||||
* `danog\AsyncOrm\ValueType::SCALAR`: Values of any scalar type, serialized as specified in the settings.
|
||||
|
||||
Using SCALAR worsens performances, please use any of the other types possible.
|
||||
Using SCALAR worsens performances, please use any of the other types if possible.
|
||||
|
||||
## Properties
|
||||
* `$name`: `string`
|
||||
* `$value`: `string`
|
||||
|
||||
## Method list:
|
||||
* [`cases(): array`](#cases-array)
|
||||
* [`from(string|int $value): static`](#from-string-int-value-static)
|
||||
* [`tryFrom(string|int $value): ?static`](#tryfrom-string-int-value-static)
|
||||
* [`cases(): array`](#cases)
|
||||
* [`from(string|int $value): static`](#from)
|
||||
* [`tryFrom(string|int $value): ?static`](#tryFrom)
|
||||
|
||||
## Methods:
|
||||
### `cases(): array`
|
||||
### <a name="cases"></a> `cases(): array`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### `from(string|int $value): static`
|
||||
### <a name="from"></a> `from(string|int $value): static`
|
||||
|
||||
|
||||
|
||||
@ -57,7 +57,7 @@ Parameters:
|
||||
|
||||
|
||||
|
||||
### `tryFrom(string|int $value): ?static`
|
||||
### <a name="tryFrom"></a> `tryFrom(string|int $value): ?static`
|
||||
|
||||
|
||||
|
||||
|
14
phpunit.xml
14
phpunit.xml
@ -1,21 +1,11 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.0/phpunit.xsd"
|
||||
bootstrap="vendor/autoload.php"
|
||||
cacheDirectory=".phpunit.cache"
|
||||
beStrictAboutCoverageMetadata="true"
|
||||
beStrictAboutOutputDuringTests="true"
|
||||
requireCoverageMetadata="false"
|
||||
failOnRisky="true"
|
||||
executionOrder="random"
|
||||
failOnWarning="true">
|
||||
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.1/phpunit.xsd" bootstrap="vendor/autoload.php" cacheDirectory=".phpunit.cache" beStrictAboutCoverageMetadata="true" beStrictAboutOutputDuringTests="true" requireCoverageMetadata="false" failOnRisky="true" executionOrder="random" failOnWarning="true">
|
||||
<testsuites>
|
||||
<testsuite name="default">
|
||||
<directory>tests</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
|
||||
<source restrictDeprecations="true" restrictNotices="true" restrictWarnings="true">
|
||||
<source restrictNotices="true" restrictWarnings="true" ignoreIndirectDeprecations="true">
|
||||
<include>
|
||||
<directory>src</directory>
|
||||
</include>
|
||||
|
Loading…
Reference in New Issue
Block a user