danog/MadelineProto
2
2
Fork 0
Code Issues Pull Requests Releases Wiki Activity

More documentation fixes

Browse Source
This commit is contained in:
Daniil Gentili 2018-03-20 12:17:07 +00:00
parent e21fa6b884
commit 71086833e9
2 changed files with 53 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/docs/SETTINGS.md
View File

@ -256,7 +256,7 @@ Description: logger mode, available logger modes:
* 4 - Call callable provided in `$settings['logger']['logger_param']`. logger_param must accept two parameters: array $message, int $level * 4 - Call callable provided in `$settings['logger']['logger_param']`. logger_param must accept two parameters: array $message, int $level
### `$settings['logger']['param']` ### `$settings['logger']['param']`
Default: `''` Default: `__DIR__.'/Madeline.log'`
Description: optional logger parameter, for modes that require it Description: optional logger parameter, for modes that require it
### `$settings['logger']['logger_level']` ### `$settings['logger']['logger_level']`
@ -291,12 +291,21 @@ Flood timeout settings
Default: 20 Default: 20
Description: Sleeps if a `FLOOD_WAIT_` error is received with duration lower than this value Description: Sleeps if a `FLOOD_WAIT_` error is received with duration lower than this value
## `$settings['secret_chats']`
Secret chat settings
### `$settings['secret_chats']['accept_chats']`
Default: `true`
Description: Can be true to accept all secret chats, false to not accept any secret chat, or an array of user IDs from which to accepts secret chats
## `$settings['upload']` ## `$settings['upload']`
Upload settings Upload settings
### `$settings['upload']['allow_automatic_uploads']` ### `$settings['upload']['allow_automatic_uploads']`
Default: true Default: `true`
Description: If false, [disables automatic upload from file path in constructors](FILES.md) Description: If false, [disables automatic upload from file path in constructors](FILES.md)
## `$settings['msg_array_limit']` ## `$settings['msg_array_limit']`

12
docs/index.md
View File

@ -15,7 +15,7 @@ It can login with a phone number (MTProto API), or with a bot token (MTProto API
## Getting started ## Getting started
``` ```php
<?php <?php
if (!file_exists('madeline.php')) { if (!file_exists('madeline.php')) {
@ -54,13 +54,13 @@ Run this code in a browser or in a console.
* [Composer from existing project](https://docs.madelineproto.xyz/docs/INSTALLATION.html#composer-from-existing-project) * [Composer from existing project](https://docs.madelineproto.xyz/docs/INSTALLATION.html#composer-from-existing-project)
* [Git](https://docs.madelineproto.xyz/docs/INSTALLATION.html#git) * [Git](https://docs.madelineproto.xyz/docs/INSTALLATION.html#git)
* [Handling updates](https://docs.madelineproto.xyz/docs/UPDATES.html) * [Handling updates](https://docs.madelineproto.xyz/docs/UPDATES.html)
* [Event driven](https://docs.madelineproto.xyz/docs/UPDATES.html#event-handler) * [Event driven](https://docs.madelineproto.xyz/docs/UPDATES.html#event-driven)
* [Event driven multithreaded](https://docs.madelineproto.xyz/docs/UPDATES.html#multithreaded-event-handler) * [Event driven multithreaded](https://docs.madelineproto.xyz/docs/UPDATES.html#event-driven-multithreaded)
* [Webhook](https://docs.madelineproto.xyz/docs/UPDATES.html#webhook) * [Webhook](https://docs.madelineproto.xyz/docs/UPDATES.html#webhook)
* [Webhook multithreaded](https://docs.madelineproto.xyz/docs/UPDATES.html#multithreaded-webhook) * [Webhook multithreaded](https://docs.madelineproto.xyz/docs/UPDATES.html#webhook-multithreaded)
* [Long polling (getupdates)](https://docs.madelineproto.xyz/docs/UPDATES.html#getupdates) * [Long polling (getupdates)](https://docs.madelineproto.xyz/docs/UPDATES.html#long-polling)
* [Callback](https://docs.madelineproto.xyz/docs/UPDATES.html#callback) * [Callback](https://docs.madelineproto.xyz/docs/UPDATES.html#callback)
* [Callback multithreaded](https://docs.madelineproto.xyz/docs/UPDATES.html#multithreaded-callback) * [Callback multithreaded](https://docs.madelineproto.xyz/docs/UPDATES.html#callback-multithreaded)
* [Settings](https://docs.madelineproto.xyz/docs/SETTINGS.html) * [Settings](https://docs.madelineproto.xyz/docs/SETTINGS.html)
* [Getting info about the current user](https://docs.madelineproto.xyz/docs/SELF.html) * [Getting info about the current user](https://docs.madelineproto.xyz/docs/SELF.html)
* [Exceptions](https://docs.madelineproto.xyz/docs/EXCEPTIONS.html) * [Exceptions](https://docs.madelineproto.xyz/docs/EXCEPTIONS.html)