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

Added serialization docs

Browse Source
This commit is contained in:
Daniil Gentili 2016-12-30 16:45:04 +01:00
parent 0c68e58103
commit d5f02639d8
2 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -351,7 +351,16 @@ See testing.php for more examples.
### Storing sessions
An istance of MadelineProto can be safely serialized or unserialized.
An istance of MadelineProto can be safely serialized or unserialized. To serialize MadelineProto to a file, usage of the `\danog\MadelineProto\Serialization` class is recommended:
```
$MadelineProto = \danog\MadelineProto\Serialization::deserialize('session.madeline');
// Do stuff
\danog\MadelineProto\Serialization::serialize('session.madeline', $MadelineProto);
```
That class serializes only if the `$MadelineProto->API->should_serialize` boolean is set to true.
The same operation should be done when serializing to another destination manually, to avoid conflicts with other PHP scripts that are trying to serialize another instance of the class.
### Exceptions

11
docs/index.md
View File

@ -355,7 +355,16 @@ See testing.php for more examples.
### Storing sessions
An istance of MadelineProto can be safely serialized or unserialized.
An istance of MadelineProto can be safely serialized or unserialized. To serialize MadelineProto to a file, usage of the `\danog\MadelineProto\Serialization` class is recommended:
```
$MadelineProto = \danog\MadelineProto\Serialization::deserialize('session.madeline');
// Do stuff
\danog\MadelineProto\Serialization::serialize('session.madeline', $MadelineProto);
```
That class serializes only if the `$MadelineProto->API->should_serialize` boolean is set to true.
The same operation should be done when serializing to another destination manually, to avoid conflicts with other PHP scripts that are trying to serialize another instance of the class.
### Exceptions