Documentation in Serialization class (#57)

* Documentation in Serialization class * phpcs fix * phpcs fi * phpcs fix * phpcs fix * phpci fix * phpci fix * Fix in var type * sintax fix * fix
2017-02-04 13:28:07 -02:00 · 2017-02-04 13:28:07 -02:00 · a8baba6057
commit a8baba6057
parent 8e9d31f06f
1 changed files with 16 additions and 0 deletions
--- a/src/danog/MadelineProto/Serialization.php
+++ b/src/danog/MadelineProto/Serialization.php
@ -17,6 +17,15 @@ namespace danog\MadelineProto;
 */
 class Serialization
 {
+    /**
+     * Serialize API class.
+     *
+     * @param string $filename the dump file
+     * @param API    $instance
+     * @param bool   $force
+     *
+     * @return number|bool
+     */
    public static function serialize($filename, $instance, $force = false)
    {
        if ($instance->API->should_serialize || !(file_exists($filename) && !empty(file_get_contents($filename))) || $force) {
@ -28,6 +37,13 @@ class Serialization
        return false;
    }

+    /**
+     * Deserialize API class.
+     *
+     * @param string $filename
+     *
+     * @return bool|API
+     */
    public static function deserialize($filename)
    {
        set_error_handler(['\danog\MadelineProto\Exception', 'ExceptionErrorHandler']);