2020-01-05 22:29:54 +00:00
|
|
|
<?php
|
2024-08-24 13:27:00 +00:00
|
|
|
|
|
|
|
// Copyright (C) 2010-2024, the Friendica project
|
|
|
|
// SPDX-FileCopyrightText: 2010-2024 the Friendica project
|
|
|
|
//
|
|
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
2020-01-05 22:29:54 +00:00
|
|
|
|
2020-01-28 01:01:32 +00:00
|
|
|
namespace Friendica;
|
2020-01-05 22:29:54 +00:00
|
|
|
|
|
|
|
/**
|
2021-01-17 21:04:00 +00:00
|
|
|
* These data transfer object classes are meant for API representations. As such, their members should be protected.
|
2020-01-05 22:29:54 +00:00
|
|
|
* Then the JsonSerializable interface ensures the protected members will be included in a JSON encode situation.
|
|
|
|
*
|
|
|
|
* Constructors are supposed to take as arguments the Friendica dependencies/model/collection/data it needs to
|
|
|
|
* populate the class members.
|
|
|
|
*/
|
2021-01-17 21:04:00 +00:00
|
|
|
abstract class BaseDataTransferObject implements \JsonSerializable
|
2020-01-05 22:29:54 +00:00
|
|
|
{
|
2020-01-28 20:28:57 +00:00
|
|
|
/**
|
|
|
|
* Returns the current entity as an json array
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
2021-01-17 21:04:00 +00:00
|
|
|
public function jsonSerialize(): array
|
2020-01-28 20:28:57 +00:00
|
|
|
{
|
|
|
|
return $this->toArray();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the current entity as an array
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
2021-01-17 21:04:00 +00:00
|
|
|
public function toArray(): array
|
2020-01-05 22:29:54 +00:00
|
|
|
{
|
|
|
|
return get_object_vars($this);
|
|
|
|
}
|
|
|
|
}
|