xref: /dokuwiki/inc/Remote/Response/ApiResponse.php (revision 8ddd9b69189e5c591f86c9f4314a06ec13778622)
1*8ddd9b69SAndreas Gohr<?php
2*8ddd9b69SAndreas Gohr
3*8ddd9b69SAndreas Gohrnamespace dokuwiki\Remote\Response;
4*8ddd9b69SAndreas Gohr
5*8ddd9b69SAndreas Gohr/**
6*8ddd9b69SAndreas Gohr * These are simple data objects that hold the response data API calls
7*8ddd9b69SAndreas Gohr *
8*8ddd9b69SAndreas Gohr * They are transmitted as associative arrays automatically created by
9*8ddd9b69SAndreas Gohr * converting the object to an array
10*8ddd9b69SAndreas Gohr */
11*8ddd9b69SAndreas Gohrabstract class ApiResponse
12*8ddd9b69SAndreas Gohr{
13*8ddd9b69SAndreas Gohr    /**
14*8ddd9b69SAndreas Gohr     * Initialize the response object with the given data
15*8ddd9b69SAndreas Gohr     *
16*8ddd9b69SAndreas Gohr     * Each response object has different properties and might get passed different data from
17*8ddd9b69SAndreas Gohr     * various internal methods. The constructor should handle all of that and also fill up
18*8ddd9b69SAndreas Gohr     * missing properties when needed.
19*8ddd9b69SAndreas Gohr     *
20*8ddd9b69SAndreas Gohr     * @param array $data
21*8ddd9b69SAndreas Gohr     */
22*8ddd9b69SAndreas Gohr    abstract public function __construct($data);
23*8ddd9b69SAndreas Gohr}
24