danog/AsyncOrm
1
0
Fork 0
mirror of https://github.com/danog/AsyncOrm.git synced 2024-11-26 20:34:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

Bump phpunit config & docs

Browse Source
This commit is contained in:
Daniil Gentili 2024-04-07 11:56:40 +02:00
parent e1c3efd92a
commit a824426d98
22 changed files with 316 additions and 311 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/docs/danog/AsyncOrm/Annotations/OrmMappedArray.md
View File

@ -15,17 +15,19 @@ Attribute use to autoconfigure ORM properties.
## Properties ## Properties
* `$keyType`: `\danog\AsyncOrm\KeyType` Key type. * `$keyType`: `danog\AsyncOrm\KeyType` Key type.
* `$valueType`: `\danog\AsyncOrm\ValueType` Value type. * `$valueType`: `danog\AsyncOrm\ValueType` Value type.
* `$cacheTtl`: `int<0, max>|null` * `$cacheTtl`: `(int<0, max> | null)` TTL of the cache, if null defaults to the value specified in the settings.
* `$optimizeIfWastedMb`: `int<1, max>|null`
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. * `$tablePostfix`: `?string` Table name postfix, if null defaults to the property name.
## Method list: ## 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: ## 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)`

100
docs/docs/danog/AsyncOrm/DbArray.md
View File

@ -16,168 +16,168 @@ DB array interface.
## Method list: ## Method list:
* [`isset(\TKey $key): bool`](#isset-tkey-key-bool) * [`isset(TKey $key): bool`](#isset)
* [`offsetGet(\TKey $offset): \TValue`](#offsetget-tkey-offset-tvalue) * [`offsetGet(TKey $offset): TValue`](#offsetGet)
* [`offsetExists(\TKey $offset): bool`](#offsetexists-tkey-offset-bool) * [`offsetExists(TKey $offset): bool`](#offsetExists)
* [`offsetSet(\TKey $offset, \TValue $value): void`](#offsetset-tkey-offset-tvalue-value-void) * [`offsetSet(TKey $offset, TValue $value): void`](#offsetSet)
* [`offsetUnset(\TKey $offset): void`](#offsetunset-tkey-offset-void) * [`offsetUnset(TKey $offset): void`](#offsetUnset)
* [`getArrayCopy(): array`](#getarraycopy-array) * [`getArrayCopy(): array`](#getArrayCopy)
* [`unset(\TKey $key): void`](#unset-tkey-key-void) * [`unset(TKey $key): void`](#unset)
* [`set(\TKey $key, \TValue $value): void`](#set-tkey-key-tvalue-value-void) * [`set(TKey $key, TValue $value): void`](#set)
* [`get(\TKey $key): ?\TValue`](#get-tkey-key-tvalue) * [`get(TKey $key): ?TValue`](#get)
* [`clear(): void`](#clear-void) * [`clear(): void`](#clear)
* [`getInstance(\danog\AsyncOrm\DbArrayBuilder $config, ?self $previous): self`](#getinstance-danog-asyncorm-dbarraybuilder-config-self-previous-self) * [`getInstance(\danog\AsyncOrm\DbArrayBuilder $config, (\danog\AsyncOrm\DbArray<TTKey, TValue>|null) $previous): \danog\AsyncOrm\DbArray<TTKey, TValue>`](#getInstance)
* [`count(): mixed`](#count-mixed) * [`count()`](#count)
* [`getIterator(): mixed`](#getiterator-mixed) * [`getIterator()`](#getIterator)
## Methods: ## Methods:
### `isset(\TKey $key): bool` ### <a name="isset"></a> `isset(TKey $key): bool`
Check if element exists. Check if element exists.
Parameters: Parameters:
* `$key`: `\TKey` * `$key`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
### `offsetGet(\TKey $offset): \TValue` ### <a name="offsetGet"></a> `offsetGet(TKey $offset): TValue`
Parameters: Parameters:
* `$offset`: `\TKey` * `$offset`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
* `\TValue` * `TValue`
### `offsetExists(\TKey $offset): bool` ### <a name="offsetExists"></a> `offsetExists(TKey $offset): bool`
Parameters: Parameters:
* `$offset`: `\TKey` * `$offset`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
### `offsetSet(\TKey $offset, \TValue $value): void` ### <a name="offsetSet"></a> `offsetSet(TKey $offset, TValue $value): void`
Parameters: Parameters:
* `$offset`: `\TKey` * `$offset`: `TKey`
* `$value`: `\TValue` * `$value`: `TValue`
#### See also: #### See also:
* `\TKey` * `TKey`
* `\TValue` * `TValue`
### `offsetUnset(\TKey $offset): void` ### <a name="offsetUnset"></a> `offsetUnset(TKey $offset): void`
Parameters: Parameters:
* `$offset`: `\TKey` * `$offset`: `TKey`
#### See also: #### 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. Unset element.
Parameters: Parameters:
* `$key`: `\TKey` * `$key`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
### `set(\TKey $key, \TValue $value): void` ### <a name="set"></a> `set(TKey $key, TValue $value): void`
Set element. Set element.
Parameters: Parameters:
* `$key`: `\TKey` * `$key`: `TKey`
* `$value`: `\TValue` * `$value`: `TValue`
#### See also: #### See also:
* `\TKey` * `TKey`
* `\TValue` * `TValue`
### `get(\TKey $key): ?\TValue` ### <a name="get"></a> `get(TKey $key): ?TValue`
Get element. Get element.
Parameters: Parameters:
* `$key`: `\TKey` * `$key`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
* `\TValue` * `TValue`
### `clear(): void` ### <a name="clear"></a> `clear(): void`
Clear all elements. 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. Get instance.
@ -185,22 +185,24 @@ Get instance.
Parameters: Parameters:
* `$config`: `\danog\AsyncOrm\DbArrayBuilder` * `$config`: `\danog\AsyncOrm\DbArrayBuilder`
* `$previous`: `?self` * `$previous`: `(\danog\AsyncOrm\DbArray<TTKey, TValue>|null)`
#### See also: #### See also:
* [`\danog\AsyncOrm\DbArrayBuilder`: Contains configuration needed to build a DbArray.](../../danog/AsyncOrm/DbArrayBuilder.md) * [`\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()`

18
docs/docs/danog/AsyncOrm/DbArrayBuilder.md
View File

@ -16,16 +16,16 @@ Contains configuration needed to build a DbArray.
## Properties ## Properties
* `$table`: `string` Table name. * `$table`: `string` Table name.
* `$settings`: `\danog\AsyncOrm\Settings` Settings. * `$settings`: `danog\AsyncOrm\Settings` Settings.
* `$keyType`: `\danog\AsyncOrm\KeyType` Key type. * `$keyType`: `danog\AsyncOrm\KeyType` Key type.
* `$valueType`: `\danog\AsyncOrm\ValueType` Value type. * `$valueType`: `danog\AsyncOrm\ValueType` Value type.
## Method list: ## 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) * [`__construct(string $table, \danog\AsyncOrm\Settings $settings, \danog\AsyncOrm\KeyType $keyType, \danog\AsyncOrm\ValueType $valueType)`](#__construct)
* [`build(?\danog\AsyncOrm\DbArray $previous = NULL): \danog\AsyncOrm\DbArray`](#build-danog-asyncorm-dbarray-previous-null-danog-asyncorm-dbarray) * [`build((\danog\AsyncOrm\DbArray<TKey, TValue>|null) $previous = NULL): \danog\AsyncOrm\DbArray<TKey, TValue>`](#build)
## Methods: ## 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. Build database array.
Parameters: Parameters:
* `$previous`: `?\danog\AsyncOrm\DbArray` * `$previous`: `(\danog\AsyncOrm\DbArray<TKey, TValue>|null)`
#### See also: #### See also:
* `TKey`
* `TValue`
* [`\danog\AsyncOrm\DbArray`: DB array interface.](../../danog/AsyncOrm/DbArray.md) * [`\danog\AsyncOrm\DbArray`: DB array interface.](../../danog/AsyncOrm/DbArray.md)

8
docs/docs/danog/AsyncOrm/DbAutoProperties.md
View File

@ -16,11 +16,11 @@ Trait that provides autoconfiguration of OrmMappedArray properties.
## Method list: ## Method list:
* [`initDbProperties(\danog\AsyncOrm\Settings $settings, string $tablePrefix): void`](#initdbproperties-danog-asyncorm-settings-settings-string-tableprefix-void) * [`initDbProperties(\danog\AsyncOrm\Settings $settings, string $tablePrefix): void`](#initDbProperties)
* [`saveDbProperties(): void`](#savedbproperties-void) * [`saveDbProperties(): void`](#saveDbProperties)
## Methods: ## Methods:
### `initDbProperties(\danog\AsyncOrm\Settings $settings, string $tablePrefix): void` ### <a name="initDbProperties"></a> `initDbProperties(\danog\AsyncOrm\Settings $settings, string $tablePrefix): void`
Initialize database properties. Initialize database properties.
@ -37,7 +37,7 @@ Parameters:
### `saveDbProperties(): void` ### <a name="saveDbProperties"></a> `saveDbProperties(): void`
Save all properties. Save all properties.

4
docs/docs/danog/AsyncOrm/DbObject.md
View File

@ -16,10 +16,10 @@ description: ""
## Method list: ## Method list:
* [`save(): void`](#save-void) * [`save(): void`](#save)
## Methods: ## Methods:
### `save(): void` ### <a name="save"></a> `save(): void`
Save object to database. Save object to database.

100
docs/docs/danog/AsyncOrm/Driver/DriverArray.md
View File

@ -16,22 +16,22 @@ Base class for driver-based arrays.
## Method list: ## 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) * [`getInstance(\danog\AsyncOrm\DbArrayBuilder $config, \danog\AsyncOrm\DbArray<TTKey, TTValue> $previous): \danog\AsyncOrm\DbArray<TTKey, TTValue>`](#getInstance)
* [`isset(\TKey $key): bool`](#isset-tkey-key-bool) * [`isset(TKey $key): bool`](#isset)
* [`offsetGet(\TKey $offset): \TValue`](#offsetget-tkey-offset-tvalue) * [`offsetGet(TKey $offset): TValue`](#offsetGet)
* [`offsetExists(\TKey $offset): bool`](#offsetexists-tkey-offset-bool) * [`offsetExists(TKey $offset): bool`](#offsetExists)
* [`offsetSet(\TKey $offset, \TValue $value): void`](#offsetset-tkey-offset-tvalue-value-void) * [`offsetSet(TKey $offset, TValue $value): void`](#offsetSet)
* [`offsetUnset(\TKey $offset): void`](#offsetunset-tkey-offset-void) * [`offsetUnset(TKey $offset): void`](#offsetUnset)
* [`getArrayCopy(): array`](#getarraycopy-array) * [`getArrayCopy(): array`](#getArrayCopy)
* [`unset(\TKey $key): void`](#unset-tkey-key-void) * [`unset(TKey $key): void`](#unset)
* [`set(\TKey $key, \TValue $value): void`](#set-tkey-key-tvalue-value-void) * [`set(TKey $key, TValue $value): void`](#set)
* [`get(\TKey $key): ?\TValue`](#get-tkey-key-tvalue) * [`get(TKey $key): ?TValue`](#get)
* [`clear(): void`](#clear-void) * [`clear(): void`](#clear)
* [`count(): mixed`](#count-mixed) * [`count()`](#count)
* [`getIterator(): mixed`](#getiterator-mixed) * [`getIterator()`](#getIterator)
## Methods: ## 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: Parameters:
* `$config`: `\danog\AsyncOrm\DbArrayBuilder` * `$config`: `\danog\AsyncOrm\DbArrayBuilder`
* `$previous`: `?\danog\AsyncOrm\DbArray` * `$previous`: `\danog\AsyncOrm\DbArray<TTKey, TTValue>`
#### See also: #### See also:
* [`\danog\AsyncOrm\DbArrayBuilder`: Contains configuration needed to build a DbArray.](../../../danog/AsyncOrm/DbArrayBuilder.md) * [`\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) * [`\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. Check if element exists.
Parameters: Parameters:
* `$key`: `\TKey` * `$key`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
### `offsetGet(\TKey $offset): \TValue` ### <a name="offsetGet"></a> `offsetGet(TKey $offset): TValue`
Parameters: Parameters:
* `$offset`: `\TKey` * `$offset`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
* `\TValue` * `TValue`
### `offsetExists(\TKey $offset): bool` ### <a name="offsetExists"></a> `offsetExists(TKey $offset): bool`
Parameters: Parameters:
* `$offset`: `\TKey` * `$offset`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
### `offsetSet(\TKey $offset, \TValue $value): void` ### <a name="offsetSet"></a> `offsetSet(TKey $offset, TValue $value): void`
Parameters: Parameters:
* `$offset`: `\TKey` * `$offset`: `TKey`
* `$value`: `\TValue` * `$value`: `TValue`
#### See also: #### See also:
* `\TKey` * `TKey`
* `\TValue` * `TValue`
### `offsetUnset(\TKey $offset): void` ### <a name="offsetUnset"></a> `offsetUnset(TKey $offset): void`
Parameters: Parameters:
* `$offset`: `\TKey` * `$offset`: `TKey`
#### See also: #### 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. Unset element.
Parameters: Parameters:
* `$key`: `\TKey` * `$key`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
### `set(\TKey $key, \TValue $value): void` ### <a name="set"></a> `set(TKey $key, TValue $value): void`
Set element. Set element.
Parameters: Parameters:
* `$key`: `\TKey` * `$key`: `TKey`
* `$value`: `\TValue` * `$value`: `TValue`
#### See also: #### See also:
* `\TKey` * `TKey`
* `\TValue` * `TValue`
### `get(\TKey $key): ?\TValue` ### <a name="get"></a> `get(TKey $key): ?TValue`
Get element. Get element.
Parameters: Parameters:
* `$key`: `\TKey` * `$key`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
* `\TValue` * `TValue`
### `clear(): void` ### <a name="clear"></a> `clear(): void`
Clear all elements. Clear all elements.
### `count(): mixed` ### <a name="count"></a> `count()`
### `getIterator(): mixed` ### <a name="getIterator"></a> `getIterator()`

84
docs/docs/danog/AsyncOrm/Driver/MemoryArray.md
View File

@ -16,23 +16,23 @@ Memory database backend.
## Method list: ## Method list:
* [`__construct(array $data)`](#__construct-array-data) * [`__construct(array $data)`](#__construct)
* [`getInstance(\danog\AsyncOrm\DbArrayBuilder $config, ?\danog\AsyncOrm\DbArray $previous): \danog\AsyncOrm\DbArray`](#getinstance-danog-asyncorm-dbarraybuilder-config-danog-asyncorm-dbarray-previous-danog-asyncorm-dbarray) * [`getInstance(\danog\AsyncOrm\DbArrayBuilder $config, ?\danog\AsyncOrm\DbArray $previous): \danog\AsyncOrm\DbArray`](#getInstance)
* [`set(string|int $key, mixed $value): void`](#set-string-int-key-mixed-value-void) * [`set(string|int $key, mixed $value): void`](#set)
* [`get(string|int $key): mixed`](#get-string-int-key-mixed) * [`get(string|int $key): mixed`](#get)
* [`unset(string|int $key): void`](#unset-string-int-key-void) * [`unset(string|int $key): void`](#unset)
* [`clear(): void`](#clear-void) * [`clear(): void`](#clear)
* [`count(): int`](#count-int) * [`count(): int`](#count)
* [`getIterator(): \Traversable`](#getiterator-traversable) * [`getIterator(): Traversable`](#getIterator)
* [`getArrayCopy(): array`](#getarraycopy-array) * [`getArrayCopy(): array`](#getArrayCopy)
* [`isset(\TKey $key): bool`](#isset-tkey-key-bool) * [`isset(TKey $key): bool`](#isset)
* [`offsetGet(\TKey $offset): \TValue`](#offsetget-tkey-offset-tvalue) * [`offsetGet(TKey $offset): TValue`](#offsetGet)
* [`offsetExists(\TKey $offset): bool`](#offsetexists-tkey-offset-bool) * [`offsetExists(TKey $offset): bool`](#offsetExists)
* [`offsetSet(\TKey $offset, \TValue $value): void`](#offsetset-tkey-offset-tvalue-value-void) * [`offsetSet(TKey $offset, TValue $value): void`](#offsetSet)
* [`offsetUnset(\TKey $offset): void`](#offsetunset-tkey-offset-void) * [`offsetUnset(TKey $offset): void`](#offsetUnset)
## Methods: ## 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: #### 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. Check if element exists.
Parameters: Parameters:
* `$key`: `\TKey` * `$key`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
### `offsetGet(\TKey $offset): \TValue` ### <a name="offsetGet"></a> `offsetGet(TKey $offset): TValue`
Parameters: Parameters:
* `$offset`: `\TKey` * `$offset`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
* `\TValue` * `TValue`
### `offsetExists(\TKey $offset): bool` ### <a name="offsetExists"></a> `offsetExists(TKey $offset): bool`
Parameters: Parameters:
* `$offset`: `\TKey` * `$offset`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
### `offsetSet(\TKey $offset, \TValue $value): void` ### <a name="offsetSet"></a> `offsetSet(TKey $offset, TValue $value): void`
Parameters: Parameters:
* `$offset`: `\TKey` * `$offset`: `TKey`
* `$value`: `\TValue` * `$value`: `TValue`
#### See also: #### See also:
* `\TKey` * `TKey`
* `\TValue` * `TValue`
### `offsetUnset(\TKey $offset): void` ### <a name="offsetUnset"></a> `offsetUnset(TKey $offset): void`
Parameters: Parameters:
* `$offset`: `\TKey` * `$offset`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`

86
docs/docs/danog/AsyncOrm/Driver/SqlArray.md
View File

@ -16,23 +16,22 @@ Generic SQL database backend.
## Method list: ## Method list:
* [`getIterator(): \Traversable<array-key, mixed>`](#getiterator-traversable-array-key-mixed) * [`getIterator(): \Traversable<array-key, mixed>`](#getIterator)
* [`get(mixed $key): mixed`](#get-mixed-key-mixed) * [`get(mixed $key): mixed`](#get)
* [`set(string|int $key, mixed $value): void`](#set-string-int-key-mixed-value-void) * [`set(string|int $key, mixed $value): void`](#set)
* [`unset(string|int $key): void`](#unset-string-int-key-void) * [`unset(string|int $key): void`](#unset)
* [`count(): \int The number of elements or public properties in the associated * [`count(): int`](#count)
array or object, respectively.`](#count-int-the-number-of-elements-or-public-properties-in-the-associated-array-or-object-respectively) * [`clear(): void`](#clear)
* [`clear(): void`](#clear-void) * [`getInstance(\danog\AsyncOrm\DbArrayBuilder $config, \danog\AsyncOrm\DbArray<TTKey, TTValue> $previous): \danog\AsyncOrm\DbArray<TTKey, TTValue>`](#getInstance)
* [`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)
* [`isset(\TKey $key): bool`](#isset-tkey-key-bool) * [`offsetGet(TKey $offset): TValue`](#offsetGet)
* [`offsetGet(\TKey $offset): \TValue`](#offsetget-tkey-offset-tvalue) * [`offsetExists(TKey $offset): bool`](#offsetExists)
* [`offsetExists(\TKey $offset): bool`](#offsetexists-tkey-offset-bool) * [`offsetSet(TKey $offset, TValue $value): void`](#offsetSet)
* [`offsetSet(\TKey $offset, \TValue $value): void`](#offsetset-tkey-offset-tvalue-value-void) * [`offsetUnset(TKey $offset): void`](#offsetUnset)
* [`offsetUnset(\TKey $offset): void`](#offsetunset-tkey-offset-void) * [`getArrayCopy(): array`](#getArrayCopy)
* [`getArrayCopy(): array`](#getarraycopy-array)
## Methods: ## Methods:
### `getIterator(): \Traversable<array-key, mixed>` ### <a name="getIterator"></a> `getIterator(): \Traversable<array-key, mixed>`
Get iterator. 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. Unset value for an offset.
@ -77,23 +76,22 @@ Parameters:
### `count(): \int The number of elements or public properties in the associated ### <a name="count"></a> `count(): int`
array or object, respectively.`
Count elements. Count elements.
Return value: The number of elements or public properties in the associated Return value: The number of elements or public properties in the associated
array or object, respectively. array or object, respectively.
### `clear(): void` ### <a name="clear"></a> `clear(): void`
Clear all elements. 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: Parameters:
* `$config`: `\danog\AsyncOrm\DbArrayBuilder` * `$config`: `\danog\AsyncOrm\DbArrayBuilder`
* `$previous`: `?\danog\AsyncOrm\DbArray` * `$previous`: `\danog\AsyncOrm\DbArray<TTKey, TTValue>`
#### See also: #### See also:
* [`\danog\AsyncOrm\DbArrayBuilder`: Contains configuration needed to build a DbArray.](../../../danog/AsyncOrm/DbArrayBuilder.md) * [`\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) * [`\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. Check if element exists.
Parameters: Parameters:
* `$key`: `\TKey` * `$key`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
### `offsetGet(\TKey $offset): \TValue` ### <a name="offsetGet"></a> `offsetGet(TKey $offset): TValue`
Parameters: Parameters:
* `$offset`: `\TKey` * `$offset`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
* `\TValue` * `TValue`
### `offsetExists(\TKey $offset): bool` ### <a name="offsetExists"></a> `offsetExists(TKey $offset): bool`
Parameters: Parameters:
* `$offset`: `\TKey` * `$offset`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
### `offsetSet(\TKey $offset, \TValue $value): void` ### <a name="offsetSet"></a> `offsetSet(TKey $offset, TValue $value): void`
Parameters: Parameters:
* `$offset`: `\TKey` * `$offset`: `TKey`
* `$value`: `\TValue` * `$value`: `TValue`
#### See also: #### See also:
* `\TKey` * `TKey`
* `\TValue` * `TValue`
### `offsetUnset(\TKey $offset): void` ### <a name="offsetUnset"></a> `offsetUnset(TKey $offset): void`
Parameters: Parameters:
* `$offset`: `\TKey` * `$offset`: `TKey`
#### See also: #### See also:
* `\TKey` * `TKey`
### `getArrayCopy(): array` ### <a name="getArrayCopy"></a> `getArrayCopy(): array`

12
docs/docs/danog/AsyncOrm/KeyType.md
View File

@ -27,18 +27,18 @@ Specifies the type of keys.
* `$value`: `string` * `$value`: `string`
## Method list: ## Method list:
* [`cases(): array`](#cases-array) * [`cases(): array`](#cases)
* [`from(string|int $value): static`](#from-string-int-value-static) * [`from(string|int $value): static`](#from)
* [`tryFrom(string|int $value): ?static`](#tryfrom-string-int-value-static) * [`tryFrom(string|int $value): ?static`](#tryFrom)
## Methods: ## 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`

14
docs/docs/danog/AsyncOrm/Serializer.md
View File

@ -16,27 +16,27 @@ Serializer interface.
## Method list: ## Method list:
* [`serialize(\TValue $value): mixed`](#serialize-tvalue-value-mixed) * [`serialize(TValue $value): mixed`](#serialize)
* [`deserialize(mixed $value): \TValue`](#deserialize-mixed-value-tvalue) * [`deserialize(mixed $value): TValue`](#deserialize)
## Methods: ## Methods:
### `serialize(\TValue $value): mixed` ### <a name="serialize"></a> `serialize(TValue $value): mixed`
Parameters: Parameters:
* `$value`: `\TValue` * `$value`: `TValue`
#### See also: #### See also:
* `\TValue` * `TValue`
### `deserialize(mixed $value): \TValue` ### <a name="deserialize"></a> `deserialize(mixed $value): TValue`
@ -47,7 +47,7 @@ Parameters:
#### See also: #### See also:
* `\TValue` * `TValue`

8
docs/docs/danog/AsyncOrm/Serializer/Igbinary.md
View File

@ -16,11 +16,11 @@ Igbinary serializer.
## Method list: ## Method list:
* [`serialize(mixed $value): mixed`](#serialize-mixed-value-mixed) * [`serialize(mixed $value): mixed`](#serialize)
* [`deserialize(mixed $value): mixed`](#deserialize-mixed-value-mixed) * [`deserialize(mixed $value): mixed`](#deserialize)
## Methods: ## 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`

8
docs/docs/danog/AsyncOrm/Serializer/Json.md
View File

@ -16,11 +16,11 @@ JSON serializer.
## Method list: ## Method list:
* [`serialize(mixed $value): mixed`](#serialize-mixed-value-mixed) * [`serialize(mixed $value): mixed`](#serialize)
* [`deserialize(mixed $value): mixed`](#deserialize-mixed-value-mixed) * [`deserialize(mixed $value): mixed`](#deserialize)
## Methods: ## 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`

8
docs/docs/danog/AsyncOrm/Serializer/Native.md
View File

@ -16,11 +16,11 @@ Native serializer.
## Method list: ## Method list:
* [`serialize(mixed $value): mixed`](#serialize-mixed-value-mixed) * [`serialize(mixed $value): mixed`](#serialize)
* [`deserialize(mixed $value): mixed`](#deserialize-mixed-value-mixed) * [`deserialize(mixed $value): mixed`](#deserialize)
## Methods: ## 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`

4
docs/docs/danog/AsyncOrm/Settings.md
View File

@ -16,10 +16,10 @@ Base interface for ORM settings.
## Method list: ## Method list:
* [`getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`](#getdriverclass-class-string-danog-asyncorm-dbarray) * [`getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`](#getDriverClass)
## Methods: ## Methods:
### `getDriverClass(): class-string<\danog\AsyncOrm\DbArray>` ### <a name="getDriverClass"></a> `getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`

10
docs/docs/danog/AsyncOrm/Settings/DriverSettings.md
View File

@ -19,15 +19,15 @@ Base settings class for database backends.
* `danog\AsyncOrm\Settings\DriverSettings::DEFAULT_CACHE_TTL`: * `danog\AsyncOrm\Settings\DriverSettings::DEFAULT_CACHE_TTL`:
## Properties ## Properties
* `$serializer`: `\danog\AsyncOrm\Serializer` * `$serializer`: `danog\AsyncOrm\Serializer`
* `$cacheTtl`: `int<0, max>` For how long to keep records in memory after last read. * `$cacheTtl`: `int<0, max>` For how long to keep records in memory after last read.
## Method list: ## 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) * [`__construct(?\danog\AsyncOrm\Serializer $serializer = NULL, int $cacheTtl = \self::DEFAULT_CACHE_TTL)`](#__construct)
* [`getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`](#getdriverclass-class-string-danog-asyncorm-dbarray) * [`getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`](#getDriverClass)
## Methods: ## 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>`

4
docs/docs/danog/AsyncOrm/Settings/MemorySettings.md
View File

@ -16,10 +16,10 @@ MemorySettings backend settings.
## Method list: ## Method list:
* [`getDriverClass(): string`](#getdriverclass-string) * [`getDriverClass(): string`](#getDriverClass)
## Methods: ## Methods:
### `getDriverClass(): string` ### <a name="getDriverClass"></a> `getDriverClass(): string`

35
docs/docs/danog/AsyncOrm/Settings/MysqlSettings.md
View File

@ -1,6 +1,6 @@
--- ---
title: "danog\\AsyncOrm\\Settings\\MysqlSettings: MySQL backend settings." 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` # `danog\AsyncOrm\Settings\MysqlSettings`
@ -12,9 +12,11 @@ description: "MariaDb 10.2+ or Mysql 5.6+ required."
MySQL backend settings. MySQL backend settings.
MariaDb 10.2+ or Mysql 5.6+ required. MariaDb 10.2+ or Mysql 5.6+ required.
## Constants ## Constants
* `danog\AsyncOrm\Settings\MysqlSettings::DEFAULT_SQL_MAX_CONNECTIONS`: * `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`: * `danog\AsyncOrm\Settings\MysqlSettings::DEFAULT_CACHE_TTL`:
## Properties ## Properties
* `$optimizeIfWastedMb`: `int<1, max>|null` * `$optimizeIfWastedMb`: `(int<1, max> | null)`
* `$maxConnections`: `positive-int` Whether to optimize MySQL tables automatically if more than the specified amount of megabytes is wasted by the MySQL engine.
* `$idleTimeout`: `positive-int`
* `$config`: `\T` Be careful when tweaking this setting as it may lead to slowdowns on startup.
* `$serializer`: `\danog\AsyncOrm\Serializer`
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. * `$cacheTtl`: `int<0, max>` For how long to keep records in memory after last read.
## Method list: ## 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) * [`__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-string) * [`getDriverClass(): string`](#getDriverClass)
## Methods: ## 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` * `$config`: `\Amp\Mysql\MysqlConfig`
* `$serializer`: `?\danog\AsyncOrm\Serializer` to use for object and mixed type values, if null defaults to either Igbinary or Native. * `$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. * `$cacheTtl`: `int<0, max>` Cache TTL in seconds, if 0 disables caching.
* `$maxConnections`: `int<\1, \max>` Maximum connection limit * `$maxConnections`: `int<1, max>` Maximum connection limit
* `$idleTimeout`: `int<\1, \max>` Idle timeout * `$idleTimeout`: `int<1, max>` Idle timeout
* `$optimizeIfWastedMb`: `?int` * `$optimizeIfWastedMb`: `?int`
#### See also: #### See also:
* `\Amp\Mysql\MysqlConfig` * `\Amp\Mysql\MysqlConfig`
* [`\danog\AsyncOrm\Serializer`: Serializer interface.](../../../danog/AsyncOrm/Serializer.md) * [`\danog\AsyncOrm\Serializer`: Serializer interface.](../../../danog/AsyncOrm/Serializer.md)
* `\max` * `max`
### `getDriverClass(): string` ### <a name="getDriverClass"></a> `getDriverClass(): string`

24
docs/docs/danog/AsyncOrm/Settings/PostgresSettings.md
View File

@ -23,18 +23,18 @@ Postgres backend settings.
* `danog\AsyncOrm\Settings\PostgresSettings::DEFAULT_CACHE_TTL`: * `danog\AsyncOrm\Settings\PostgresSettings::DEFAULT_CACHE_TTL`:
## Properties ## Properties
* `$maxConnections`: `positive-int` * `$maxConnections`: `positive-int` Maximum connection limit.
* `$idleTimeout`: `positive-int` * `$idleTimeout`: `positive-int` Idle timeout.
* `$config`: `\T` * `$config`: `T`
* `$serializer`: `\danog\AsyncOrm\Serializer` * `$serializer`: `danog\AsyncOrm\Serializer`
* `$cacheTtl`: `int<0, max>` For how long to keep records in memory after last read. * `$cacheTtl`: `int<0, max>` For how long to keep records in memory after last read.
## Method list: ## 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) * [`__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-string) * [`getDriverClass(): string`](#getDriverClass)
## Methods: ## 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` * `$config`: `\Amp\Postgres\PostgresConfig`
* `$serializer`: `?\danog\AsyncOrm\Serializer` to use for object and mixed type values, if null defaults to either Igbinary or Native. * `$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
* `$maxConnections`: `int<\1, \max>` Maximum connection limit * `$maxConnections`: `int<1, max>` Maximum connection limit
* `$idleTimeout`: `int<\1, \max>` Idle timeout * `$idleTimeout`: `int<1, max>` Idle timeout
#### See also: #### See also:
* `\Amp\Postgres\PostgresConfig` * `\Amp\Postgres\PostgresConfig`
* [`\danog\AsyncOrm\Serializer`: Serializer interface.](../../../danog/AsyncOrm/Serializer.md) * [`\danog\AsyncOrm\Serializer`: Serializer interface.](../../../danog/AsyncOrm/Serializer.md)
* `\max` * `max`
### `getDriverClass(): string` ### <a name="getDriverClass"></a> `getDriverClass(): string`

16
docs/docs/danog/AsyncOrm/Settings/RedisSettings.md
View File

@ -19,16 +19,16 @@ Redis backend settings.
* `danog\AsyncOrm\Settings\RedisSettings::DEFAULT_CACHE_TTL`: * `danog\AsyncOrm\Settings\RedisSettings::DEFAULT_CACHE_TTL`:
## Properties ## Properties
* `$config`: `\Amp\Redis\RedisConfig` * `$config`: `Amp\Redis\RedisConfig`
* `$serializer`: `\danog\AsyncOrm\Serializer` * `$serializer`: `danog\AsyncOrm\Serializer`
* `$cacheTtl`: `int<0, max>` For how long to keep records in memory after last read. * `$cacheTtl`: `int<0, max>` For how long to keep records in memory after last read.
## Method list: ## 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) * [`__construct(\Amp\Redis\RedisConfig $config, ?\danog\AsyncOrm\Serializer $serializer = NULL, int<0, max> $cacheTtl = \self::DEFAULT_CACHE_TTL)`](#__construct)
* [`getDriverClass(): string`](#getdriverclass-string) * [`getDriverClass(): string`](#getDriverClass)
## Methods: ## 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` * `$config`: `\Amp\Redis\RedisConfig`
* `$serializer`: `?\danog\AsyncOrm\Serializer` to use for object and mixed type values, if null defaults to either Igbinary or Native. * `$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: #### See also:
* `\Amp\Redis\RedisConfig` * `\Amp\Redis\RedisConfig`
* [`\danog\AsyncOrm\Serializer`: Serializer interface.](../../../danog/AsyncOrm/Serializer.md) * [`\danog\AsyncOrm\Serializer`: Serializer interface.](../../../danog/AsyncOrm/Serializer.md)
* `\max` * `max`
### `getDriverClass(): string` ### <a name="getDriverClass"></a> `getDriverClass(): string`

24
docs/docs/danog/AsyncOrm/Settings/SqlSettings.md
View File

@ -23,18 +23,18 @@ Generic SQL db backend settings.
* `danog\AsyncOrm\Settings\SqlSettings::DEFAULT_CACHE_TTL`: * `danog\AsyncOrm\Settings\SqlSettings::DEFAULT_CACHE_TTL`:
## Properties ## Properties
* `$maxConnections`: `positive-int` * `$maxConnections`: `positive-int` Maximum connection limit.
* `$idleTimeout`: `positive-int` * `$idleTimeout`: `positive-int` Idle timeout.
* `$config`: `\T` * `$config`: `T`
* `$serializer`: `\danog\AsyncOrm\Serializer` * `$serializer`: `danog\AsyncOrm\Serializer`
* `$cacheTtl`: `int<0, max>` For how long to keep records in memory after last read. * `$cacheTtl`: `int<0, max>` For how long to keep records in memory after last read.
## Method list: ## 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) * [`__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-class-string-danog-asyncorm-dbarray) * [`getDriverClass(): class-string<\danog\AsyncOrm\DbArray>`](#getDriverClass)
## Methods: ## 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` * `$config`: `\Amp\Sql\SqlConfig`
* `$serializer`: `?\danog\AsyncOrm\Serializer` to use for object and mixed type values. * `$serializer`: `?\danog\AsyncOrm\Serializer` to use for object and mixed type values.
* `$cacheTtl`: `int<\0, \max>` Cache TTL in seconds * `$cacheTtl`: `int<0, max>` Cache TTL in seconds
* `$maxConnections`: `int<\1, \max>` Maximum connection limit * `$maxConnections`: `int<1, max>` Maximum connection limit
* `$idleTimeout`: `int<\1, \max>` Idle timeout * `$idleTimeout`: `int<1, max>` Idle timeout
#### See also: #### See also:
* `\Amp\Sql\SqlConfig` * `\Amp\Sql\SqlConfig`
* [`\danog\AsyncOrm\Serializer`: Serializer interface.](../../../danog/AsyncOrm/Serializer.md) * [`\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>`

14
docs/docs/danog/AsyncOrm/ValueType.md
View File

@ -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. * `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 ## Properties
* `$name`: `string` * `$name`: `string`
* `$value`: `string` * `$value`: `string`
## Method list: ## Method list:
* [`cases(): array`](#cases-array) * [`cases(): array`](#cases)
* [`from(string|int $value): static`](#from-string-int-value-static) * [`from(string|int $value): static`](#from)
* [`tryFrom(string|int $value): ?static`](#tryfrom-string-int-value-static) * [`tryFrom(string|int $value): ?static`](#tryFrom)
## Methods: ## 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`

32
phpunit.xml
View File

@ -1,23 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" <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">
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.0/phpunit.xsd" <testsuites>
bootstrap="vendor/autoload.php" <testsuite name="default">
cacheDirectory=".phpunit.cache" <directory>tests</directory>
beStrictAboutCoverageMetadata="true" </testsuite>
beStrictAboutOutputDuringTests="true" </testsuites>
requireCoverageMetadata="false" <source restrictNotices="true" restrictWarnings="true" ignoreIndirectDeprecations="true">
failOnRisky="true" <include>
executionOrder="random" <directory>src</directory>
failOnWarning="true"> </include>
<testsuites> </source>
<testsuite name="default">
<directory>tests</directory>
</testsuite>
</testsuites>
<source restrictDeprecations="true" restrictNotices="true" restrictWarnings="true">
<include>
<directory>src</directory>
</include>
</source>
</phpunit> </phpunit>