]> git.mxchange.org Git - friendica.git/blob - src/BaseDataTransferObject.php
Remove the activity
[friendica.git] / src / BaseDataTransferObject.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2010-2022, the Friendica project
4  *
5  * @license GNU AGPL version 3 or any later version
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU Affero General Public License as
9  * published by the Free Software Foundation, either version 3 of the
10  * License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU Affero General Public License for more details.
16  *
17  * You should have received a copy of the GNU Affero General Public License
18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
19  *
20  */
21
22 namespace Friendica;
23
24 /**
25  * These data transfer object classes are meant for API representations. As such, their members should be protected.
26  * Then the JsonSerializable interface ensures the protected members will be included in a JSON encode situation.
27  *
28  * Constructors are supposed to take as arguments the Friendica dependencies/model/collection/data it needs to
29  * populate the class members.
30  */
31 abstract class BaseDataTransferObject implements \JsonSerializable
32 {
33         /**
34          * Returns the current entity as an json array
35          *
36          * @return array
37          */
38         public function jsonSerialize(): array
39         {
40                 return $this->toArray();
41         }
42
43         /**
44          * Returns the current entity as an array
45          *
46          * @return array
47          */
48         public function toArray(): array
49         {
50                 return get_object_vars($this);
51         }
52 }