xref: /dokuwiki/inc/Remote/Response/ApiResponse.php (revision 093fe67e98c0cdb4b73fd46938e49b64971483c2)
18ddd9b69SAndreas Gohr<?php
28ddd9b69SAndreas Gohr
38ddd9b69SAndreas Gohrnamespace dokuwiki\Remote\Response;
48ddd9b69SAndreas Gohr
58ddd9b69SAndreas Gohr/**
68ddd9b69SAndreas Gohr * These are simple data objects that hold the response data API calls
78ddd9b69SAndreas Gohr *
88ddd9b69SAndreas Gohr * They are transmitted as associative arrays automatically created by
958ae4747SAndreas Gohr * converting the object to an array using all public properties.
108ddd9b69SAndreas Gohr */
11*093fe67eSAndreas Gohrabstract class ApiResponse implements \Stringable
128ddd9b69SAndreas Gohr{
138268b284SAndreas Gohr    /**
148268b284SAndreas Gohr     * A string representation of this object
158268b284SAndreas Gohr     *
168268b284SAndreas Gohr     * Used for sorting and debugging
178268b284SAndreas Gohr     *
188268b284SAndreas Gohr     * @return string
198268b284SAndreas Gohr     */
20*093fe67eSAndreas Gohr    abstract public function __toString(): string;
218ddd9b69SAndreas Gohr}
22