mirror of
https://github.com/danog/MadelineProto.git
synced 2024-11-27 01:34:40 +01:00
Improve documentation
This commit is contained in:
parent
c6ae9a9255
commit
7aafde0d8d
@ -53,10 +53,7 @@ foreach ($files as $file) {
|
||||
ksort($orderedfiles);
|
||||
foreach ($orderedfiles as $key => $filename) {
|
||||
$lines = explode("\n", file_get_contents($filename));
|
||||
while (end($lines) === '') {
|
||||
unset($lines[count($lines)-1]);
|
||||
}
|
||||
if (strpos(end($lines), "Next")) {
|
||||
while (end($lines) === '' || strpos(end($lines), "Next")) {
|
||||
unset($lines[count($lines)-1]);
|
||||
}
|
||||
if (isset($orderedfiles[$key+1])) {
|
||||
|
@ -111,15 +111,4 @@ foreach ($updates as $update) {
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/INLINE_BUTTONS.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/SECRET_CHATS.html"><input type="submit" value="Next section" /></form>
|
@ -42,9 +42,4 @@ You can also use `get_info` to get chat info, see [here for the parameters and t
|
||||
* Speed: very fast
|
||||
* Caching: full
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/FILES.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/DIALOGS.html"><input type="submit" value="Next section" /></form>
|
@ -88,10 +88,4 @@ While writing this client, I looked at many projects for inspiration and help. H
|
||||
|
||||
Thanks to the devs that contributed to these projects, MadelineProto is now an easy, well-written and complete MTProto client.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/PROXY.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/TEMPLATES.html"><input type="submit" value="Next section" /></form>
|
@ -20,9 +20,4 @@ To change the session file after starting MadelineProto, do the following:
|
||||
$MadelineProto->session = 'newsession.madeline';
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/LOGIN.html"><input type="submit" value="Next section" /></form>
|
@ -29,11 +29,4 @@ foreach ($MadelineProto->API->chats as $bot_api_id => $chat) {
|
||||
Since bots cannot run `get_dialogs`, you must make use of the internal MadelineProto database to get a list of all users, chats and channels MadelineProto has seen.
|
||||
`$MadelineProto->API->chats` contains a list of [Chat](../API_docs/types/Chat.md) and [User](../API_docs/types/User.md) objects, indexed by bot API id.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/CHAT_INFO.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/INLINE_BUTTONS.html"><input type="submit" value="Next section" /></form>
|
@ -102,13 +102,4 @@ try {
|
||||
}
|
||||
```
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/FLOOD_WAIT.html"><input type="submit" value="Next section" /></form>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/SELF.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/FLOOD_WAIT.html"><input type="submit" value="Next section" /></form>
|
@ -40,11 +40,4 @@
|
||||
|
||||
* [Clickable inline buttons](#inline-buttons)!
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/LOGIN.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/REQUIREMENTS.html"><input type="submit" value="Next section" /></form>
|
@ -426,10 +426,4 @@ $output_file_name = $MadelineProto->download_to_file(
|
||||
);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/USING_METHODS.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/CHAT_INFO.html"><input type="submit" value="Next section" /></form>
|
@ -11,11 +11,4 @@ floodwaitrate = time it took you to make the method calls + X
|
||||
|
||||
Use sleep to execute max N calls in `floodwaitrate` seconds, this way you won't get flood waited!
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/EXCEPTIONS.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/LOGGING.html"><input type="submit" value="Next section" /></form>
|
@ -50,11 +50,4 @@ And click them:
|
||||
$button->click();
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/DIALOGS.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/CALLS.html"><input type="submit" value="Next section" /></form>
|
@ -119,11 +119,4 @@ cp -a *php tests userbots .env* ..
|
||||
|
||||
Now open `.env` and edit its values as needed.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/REQUIREMENTS.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/UPDATES.html"><input type="submit" value="Next section" /></form>
|
@ -17,10 +17,4 @@ MadelineProto provides a unified class for logging messages to the logging desti
|
||||
|
||||
By default, `$level` is `\danog\MadelineProto\Logger:NOTICE`.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/FLOOD_WAIT.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/USING_METHODS.html"><input type="submit" value="Next section" /></form>
|
@ -57,11 +57,4 @@ $MadelineProto->logout();
|
||||
|
||||
Use `logout` to logout, see [here for the parameters and the result](https://docs.madelineproto.xyz/logout.html).
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/CREATING_A_CLIENT.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/FEATURES.html"><input type="submit" value="Next section" /></form>
|
@ -16,10 +16,4 @@ All MadelineProto wrapper methods (for example upload, download, upload_encrypte
|
||||
|
||||
td-cli wrappers are also present: you can use the tdcli_function in lua and pass mtproto updates to the tdcli_update_callback via PHP, they will be automatically converted to/from td objects. Please note that the object conversion is not complete, feel free to contribute to the conversion module in [`src/danog/MadelineProto/Conversion/TD.php`](https://github.com/danog/MadelineProto/raw/master/src/danog/MadelineProto/TL/Conversion/TD.php).
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/SECRET_CHATS.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/PROXY.html"><input type="submit" value="Next section" /></form>
|
@ -120,10 +120,4 @@ Works like [socket_getsockname](http://php.net/manual/en/function.socket-getsock
|
||||
|
||||
Can return additional HTTP headers to use when the HTTP protocol is being used.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/LUA.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/CONTRIB.html"><input type="submit" value="Next section" /></form>
|
@ -13,10 +13,4 @@ sudo apt-get install php7.2 php7.2-dev php7.2-fpm php7.2-curl php7.2-xml php7.2-
|
||||
|
||||
Next, follow the instructions on voip.madelineproto.xyz and prime.madelineproto.xyz to install libtgvoip and PrimeModule.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/FEATURES.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/INSTALLATION.html"><input type="submit" value="Next section" /></form>
|
@ -66,12 +66,4 @@ $secret_chat = $MadelineProto->get_secret_chat($chat);
|
||||
|
||||
This method gets info about a certain chat.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/CALLS.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/LUA.html"><input type="submit" value="Next section" /></form>
|
@ -8,10 +8,4 @@ $me = $MadelineProto->get_self();
|
||||
|
||||
[`get_self`](https://docs.madelineproto.xyz/get_self.html) returns a [User object](API_docs/types/User.md) that contains info about the currently logged in user/bot, or false if the current instance is not logged in.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/SETTINGS.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/EXCEPTIONS.html"><input type="submit" value="Next section" /></form>
|
@ -396,11 +396,4 @@ The settings array can be accessed and modified in the instantiated class by acc
|
||||
$MadelineProto->settings['updates']['handle_updates'] = true; // reenable update fetching
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/UPDATES.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/SELF.html"><input type="submit" value="Next section" /></form>
|
@ -31,7 +31,4 @@ $MadelineProto->set_web_template($new_template);
|
||||
|
||||
The new template must have a structure similar the the default template.
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/#very-complex-and-complete-examples"><input type="submit" value="Next section" /></form>
|
@ -193,15 +193,4 @@ $MadelineProto->loop(-1);
|
||||
This way, each update will be managed in its own fork.
|
||||
Note that multiprocessing is not the same as multithreading, and should be avoided unless lengthy operations are made in the update handler.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/INSTALLATION.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/SETTINGS.html"><input type="submit" value="Next section" /></form>
|
@ -98,9 +98,4 @@ $MadelineProto->messages->sendMessage(['peer' => '@danogentili', 'message' => 'l
|
||||
|
||||
If the queue if the specified queue name does not exist, it will be created.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<form action="https://docs.madelineproto.xyz/docs/LOGGING.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/FILES.html"><input type="submit" value="Next section" /></form>
|
@ -89,12 +89,10 @@ class Handler extends \danog\MadelineProto\Connection
|
||||
if ($buffer) {
|
||||
$message = $buffer;
|
||||
$buffer = '';
|
||||
var_dump("using buffer");
|
||||
} else {
|
||||
$message = $this->read_message();
|
||||
}
|
||||
} catch (\danog\MadelineProto\NothingInTheSocketException $e) {
|
||||
var_dump("nothing in the socket");
|
||||
continue;
|
||||
}
|
||||
|
||||
@ -103,7 +101,6 @@ class Handler extends \danog\MadelineProto\Connection
|
||||
if ($message['_'] !== 'socketMessageRequest') {
|
||||
throw new \danog\MadelineProto\Exception('Invalid object received');
|
||||
}
|
||||
var_dump($message);
|
||||
$request_id = $message['request_id'];
|
||||
$this->send_response($request_id, $this->on_request($request_id, $message['method'], $message['args']));
|
||||
} catch (\danog\MadelineProto\TL\Exception $e) {
|
||||
|
Loading…
Reference in New Issue
Block a user