559 lines
12 KiB
Markdown
559 lines
12 KiB
Markdown
---
|
|
title: danog\MadelineProto\Settings: Settings class used for configuring MadelineProto.
|
|
description:
|
|
|
|
---
|
|
# `danog\MadelineProto\Settings`
|
|
[Back to index](../../index.md)
|
|
|
|
> Author: Daniil Gentili <daniil@daniil.it>
|
|
|
|
|
|
Settings class used for configuring MadelineProto.
|
|
|
|
|
|
|
|
|
|
## Method list:
|
|
* `parseFromLegacy(\danog\MadelineProto\SettingsAbstract|array $settings): \danog\MadelineProto\SettingsAbstract`
|
|
* `mergeArray(array $settings): void`
|
|
* `merge(\danog\MadelineProto\SettingsAbstract $settings): void`
|
|
* `getDefaultDc(): int`
|
|
* `getDefaultDcParams(): array`
|
|
* `setDefaultDc(int $dc): self`
|
|
* `getAppInfo(): \danog\MadelineProto\Settings\AppInfo`
|
|
* `setAppInfo(\danog\MadelineProto\Settings\AppInfo $appInfo): self`
|
|
* `getAuth(): \danog\MadelineProto\Settings\Auth`
|
|
* `setAuth(\danog\MadelineProto\Settings\Auth $auth): self`
|
|
* `getConnection(): \danog\MadelineProto\Settings\Connection`
|
|
* `setConnection(\danog\MadelineProto\Settings\Connection $connection): self`
|
|
* `getFiles(): \danog\MadelineProto\Settings\Files`
|
|
* `setFiles(\danog\MadelineProto\Settings\Files $files): self`
|
|
* `getLogger(): \danog\MadelineProto\Settings\Logger`
|
|
* `setLogger(\danog\MadelineProto\Settings\Logger $logger): self`
|
|
* `getPeer(): \danog\MadelineProto\Settings\Peer`
|
|
* `setPeer(\danog\MadelineProto\Settings\Peer $peer): self`
|
|
* `getPwr(): \danog\MadelineProto\Settings\Pwr`
|
|
* `setPwr(\danog\MadelineProto\Settings\Pwr $pwr): self`
|
|
* `getRpc(): \danog\MadelineProto\Settings\RPC`
|
|
* `setRpc(\danog\MadelineProto\Settings\RPC $rpc): self`
|
|
* `getSecretChats(): \danog\MadelineProto\Settings\SecretChats`
|
|
* `setSecretChats(\danog\MadelineProto\Settings\SecretChats $secretChats): self`
|
|
* `getSerialization(): \danog\MadelineProto\Settings\Serialization`
|
|
* `setSerialization(\danog\MadelineProto\Settings\Serialization $serialization): self`
|
|
* `getSchema(): \danog\MadelineProto\Settings\TLSchema`
|
|
* `setSchema(\danog\MadelineProto\Settings\TLSchema $schema): self`
|
|
* `getDb(): \danog\MadelineProto\Settings\DatabaseAbstract`
|
|
* `setDb(\danog\MadelineProto\Settings\DatabaseAbstract $db): self`
|
|
* `getIpc(): \danog\MadelineProto\Settings\Ipc`
|
|
* `setIpc(\danog\MadelineProto\Settings\Ipc $ipc): self`
|
|
* `getTemplates(): \danog\MadelineProto\Settings\Templates`
|
|
* `setTemplates(\danog\MadelineProto\Settings\Templates $templates): self`
|
|
* `hasChanged(): bool`
|
|
|
|
## Methods:
|
|
### `parseFromLegacy(\danog\MadelineProto\SettingsAbstract|array $settings): \danog\MadelineProto\SettingsAbstract`
|
|
|
|
Create settings object from possibly legacy settings array.
|
|
|
|
|
|
Parameters:
|
|
* `$settings`: `\danog\MadelineProto\SettingsAbstract|array` Settings
|
|
|
|
|
|
#### See also:
|
|
* `\danog\MadelineProto\SettingsAbstract`
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `mergeArray(array $settings): void`
|
|
|
|
Merge legacy array settings.
|
|
|
|
|
|
Parameters:
|
|
* `$settings`: `array` Settings
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `merge(\danog\MadelineProto\SettingsAbstract $settings): void`
|
|
|
|
Merge another instance of settings.
|
|
|
|
|
|
Parameters:
|
|
* `$settings`: `\danog\MadelineProto\SettingsAbstract` Settings
|
|
|
|
|
|
#### See also:
|
|
* `\danog\MadelineProto\SettingsAbstract`
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getDefaultDc(): int`
|
|
|
|
Get default DC ID.
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getDefaultDcParams(): array`
|
|
|
|
Get default DC params.
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `setDefaultDc(int $dc): self`
|
|
|
|
Set default DC ID.
|
|
|
|
|
|
Parameters:
|
|
* `$dc`: `int` DC ID
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getAppInfo(): \danog\MadelineProto\Settings\AppInfo`
|
|
|
|
Get app information.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\AppInfo`: App information.](AppInfo.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `setAppInfo(\danog\MadelineProto\Settings\AppInfo $appInfo): self`
|
|
|
|
Set app information.
|
|
|
|
|
|
Parameters:
|
|
* `$appInfo`: `\danog\MadelineProto\Settings\AppInfo` App information.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\AppInfo`: App information.](AppInfo.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getAuth(): \danog\MadelineProto\Settings\Auth`
|
|
|
|
Get cryptography settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Auth`: Cryptography settings.](Auth.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `setAuth(\danog\MadelineProto\Settings\Auth $auth): self`
|
|
|
|
Set cryptography settings.
|
|
|
|
|
|
Parameters:
|
|
* `$auth`: `\danog\MadelineProto\Settings\Auth` Cryptography settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Auth`: Cryptography settings.](Auth.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getConnection(): \danog\MadelineProto\Settings\Connection`
|
|
|
|
Get connection settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Connection`: Connection settings.](Connection.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `setConnection(\danog\MadelineProto\Settings\Connection $connection): self`
|
|
|
|
Set connection settings.
|
|
|
|
|
|
Parameters:
|
|
* `$connection`: `\danog\MadelineProto\Settings\Connection` Connection settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Connection`: Connection settings.](Connection.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getFiles(): \danog\MadelineProto\Settings\Files`
|
|
|
|
Get file management settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Files`: File management settings.](Files.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `setFiles(\danog\MadelineProto\Settings\Files $files): self`
|
|
|
|
Set file management settings.
|
|
|
|
|
|
Parameters:
|
|
* `$files`: `\danog\MadelineProto\Settings\Files` File management settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Files`: File management settings.](Files.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getLogger(): \danog\MadelineProto\Settings\Logger`
|
|
|
|
Get logger settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Logger`: Logger settings.](Logger.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `setLogger(\danog\MadelineProto\Settings\Logger $logger): self`
|
|
|
|
Set logger settings.
|
|
|
|
|
|
Parameters:
|
|
* `$logger`: `\danog\MadelineProto\Settings\Logger` Logger settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Logger`: Logger settings.](Logger.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getPeer(): \danog\MadelineProto\Settings\Peer`
|
|
|
|
Get peer database settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Peer`: Peer database settings.](Peer.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `setPeer(\danog\MadelineProto\Settings\Peer $peer): self`
|
|
|
|
Set peer database settings.
|
|
|
|
|
|
Parameters:
|
|
* `$peer`: `\danog\MadelineProto\Settings\Peer` Peer database settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Peer`: Peer database settings.](Peer.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getPwr(): \danog\MadelineProto\Settings\Pwr`
|
|
|
|
Get PWRTelegram settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Pwr`: PWRTelegram settings.](Pwr.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `setPwr(\danog\MadelineProto\Settings\Pwr $pwr): self`
|
|
|
|
Set PWRTelegram settings.
|
|
|
|
|
|
Parameters:
|
|
* `$pwr`: `\danog\MadelineProto\Settings\Pwr` PWRTelegram settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Pwr`: PWRTelegram settings.](Pwr.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getRpc(): \danog\MadelineProto\Settings\RPC`
|
|
|
|
Get RPC settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\RPC`: RPC settings.](RPC.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `setRpc(\danog\MadelineProto\Settings\RPC $rpc): self`
|
|
|
|
Set RPC settings.
|
|
|
|
|
|
Parameters:
|
|
* `$rpc`: `\danog\MadelineProto\Settings\RPC` RPC settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\RPC`: RPC settings.](RPC.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getSecretChats(): \danog\MadelineProto\Settings\SecretChats`
|
|
|
|
Get secret chat settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\SecretChats`: Secret chat settings.](SecretChats.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `setSecretChats(\danog\MadelineProto\Settings\SecretChats $secretChats): self`
|
|
|
|
Set secret chat settings.
|
|
|
|
|
|
Parameters:
|
|
* `$secretChats`: `\danog\MadelineProto\Settings\SecretChats` Secret chat settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\SecretChats`: Secret chat settings.](SecretChats.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getSerialization(): \danog\MadelineProto\Settings\Serialization`
|
|
|
|
Get serialization settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Serialization`: Serialization settings.](Serialization.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `setSerialization(\danog\MadelineProto\Settings\Serialization $serialization): self`
|
|
|
|
Set serialization settings.
|
|
|
|
|
|
Parameters:
|
|
* `$serialization`: `\danog\MadelineProto\Settings\Serialization` Serialization settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Serialization`: Serialization settings.](Serialization.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getSchema(): \danog\MadelineProto\Settings\TLSchema`
|
|
|
|
Get TL schema settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\TLSchema`: TL schema settings.](TLSchema.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `setSchema(\danog\MadelineProto\Settings\TLSchema $schema): self`
|
|
|
|
Set TL schema settings.
|
|
|
|
|
|
Parameters:
|
|
* `$schema`: `\danog\MadelineProto\Settings\TLSchema` TL schema settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\TLSchema`: TL schema settings.](TLSchema.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getDb(): \danog\MadelineProto\Settings\DatabaseAbstract`
|
|
|
|
Get database settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\DatabaseAbstract`: Base class for storage backends.](DatabaseAbstract.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `setDb(\danog\MadelineProto\Settings\DatabaseAbstract $db): self`
|
|
|
|
Set database settings.
|
|
|
|
|
|
Parameters:
|
|
* `$db`: `\danog\MadelineProto\Settings\DatabaseAbstract` DatabaseAbstract settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\DatabaseAbstract`: Base class for storage backends.](DatabaseAbstract.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getIpc(): \danog\MadelineProto\Settings\Ipc`
|
|
|
|
Get IPC server settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Ipc`: IPC server settings.](Ipc.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `setIpc(\danog\MadelineProto\Settings\Ipc $ipc): self`
|
|
|
|
Set IPC server settings.
|
|
|
|
|
|
Parameters:
|
|
* `$ipc`: `\danog\MadelineProto\Settings\Ipc` IPC server settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Ipc`: IPC server settings.](Ipc.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `getTemplates(): \danog\MadelineProto\Settings\Templates`
|
|
|
|
Get template settings.
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Templates`: Web and CLI template settings for login.](Templates.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `setTemplates(\danog\MadelineProto\Settings\Templates $templates): self`
|
|
|
|
Set template settings.
|
|
|
|
|
|
Parameters:
|
|
* `$templates`: `\danog\MadelineProto\Settings\Templates` Template settings
|
|
|
|
|
|
#### See also:
|
|
* [`\danog\MadelineProto\Settings\Templates`: Web and CLI template settings for login.](Templates.md)
|
|
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
### `hasChanged(): bool`
|
|
|
|
Get whether this setting was changed, also applies changes.
|
|
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
|
|
|
---
|
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|