MadelineProtoDocs/docs/PHP/danog/MadelineProto/Db/SqlArray.md

176 lines
2.9 KiB
Markdown
Raw Normal View History

2020-10-15 18:42:54 +02:00
---
title: danog\MadelineProto\Db\SqlArray: Generic SQL database backend.
description:
---
# `danog\MadelineProto\Db\SqlArray`
[Back to index](../../../index.md)
> Author: Daniil Gentili <daniil@daniil.it>
Generic SQL database backend.
## Method list:
* `getInstance(string $table, \danog\MadelineProto\Db\DbArray|array|null $value, \danog\MadelineProto\Settings\Database\DatabaseAbstract $settings): \Amp\Promise`
* `getArrayCopy(): \Amp\Promise`
* `isset(string|int $key): \Amp\Promise`
* `offsetGet(string|int $index): \Amp\Promise`
* `offsetSet(string|int $index, mixed $value): void`
* `offsetUnset(string|int $index): \Amp\Promise`
* `count(): \Amp\Promise<int>`
* `getIterator()`
## Methods:
### `getInstance(string $table, \danog\MadelineProto\Db\DbArray|array|null $value, \danog\MadelineProto\Settings\Database\DatabaseAbstract $settings): \Amp\Promise`
Parameters:
* `$table`: `string`
* `$value`: `\danog\MadelineProto\Db\DbArray|array|null`
* `$settings`: `\danog\MadelineProto\Settings\Database\DatabaseAbstract`
Fully typed return value:
```
\Amp\Promise<static>
```
#### See also:
* [`\danog\MadelineProto\Db\DbArray`: DB array interface.](./DbArray.md)
* [`\danog\MadelineProto\Settings\Database\DatabaseAbstract`: Base class for database backends.](../Settings/Database/DatabaseAbstract.md)
* `\Amp\Promise`
2020-10-15 19:11:10 +02:00
---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
2020-10-15 18:42:54 +02:00
### `getArrayCopy(): \Amp\Promise`
Get Array copy.
Fully typed return value:
```
\Amp\Promise<array<string|int, \T>>
```
#### See also:
* `\T`
* `\Amp\Promise`
2020-10-15 19:11:10 +02:00
---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
2020-10-15 18:42:54 +02:00
### `isset(string|int $key): \Amp\Promise`
Check if element is set.
Parameters:
* `$key`: `string|int`
Fully typed return value:
```
\Amp\Promise<bool>
```
#### See also:
* `\Amp\Promise`
2020-10-15 19:11:10 +02:00
---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
2020-10-15 18:42:54 +02:00
### `offsetGet(string|int $index): \Amp\Promise`
Get element.
Parameters:
* `$index`: `string|int`
Fully typed return value:
```
\Amp\Promise<\T>
```
#### See also:
* `\T`
* `\Amp\Promise`
2020-10-15 19:11:10 +02:00
---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
2020-10-15 18:42:54 +02:00
### `offsetSet(string|int $index, mixed $value): void`
Set element.
Parameters:
* `$index`: `string|int`
* `$value`: `mixed`
Full type:
```
\T
```
#### See also:
* `\T`
2020-10-15 19:11:10 +02:00
---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
2020-10-15 18:42:54 +02:00
### `offsetUnset(string|int $index): \Amp\Promise`
Unset element.
Parameters:
* `$index`: `string|int` Offset
#### See also:
* `\Amp\Promise`
2020-10-15 19:11:10 +02:00
---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
2020-10-15 18:42:54 +02:00
### `count(): \Amp\Promise<int>`
Count number of elements.
#### See also:
* `\Amp\Promise`
2020-10-15 19:11:10 +02:00
---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
2020-10-15 18:42:54 +02:00
### `getIterator()`
Get iterator.
2020-10-15 19:11:10 +02:00
---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
2020-10-15 18:42:54 +02:00
2020-10-15 19:11:10 +02:00
---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)