Files
deck/lib/Db/RelationalObject.php
Julius Härtl 46f2d448ab Add typing to jsonSerialize
Signed-off-by: Julius Härtl <jus@bitgrid.net>
2022-04-08 15:39:59 +02:00

67 lines
1.8 KiB
PHP

<?php
/**
* @copyright Copyright (c) 2017 Julius Härtl <jus@bitgrid.net>
*
* @author Julius Härtl <jus@bitgrid.net>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Deck\Db;
use JsonSerializable;
class RelationalObject implements JsonSerializable {
protected $primaryKey;
protected $object;
/**
* RelationalObject constructor.
*
* @param $primaryKey string
* @param $object
*/
public function __construct($primaryKey, $object) {
$this->primaryKey = $primaryKey;
$this->object = $object;
}
public function jsonSerialize(): array {
return array_merge(
['primaryKey' => $this->primaryKey],
$this->getObjectSerialization()
);
}
/**
* This method should be overwritten if object doesn't implement \JsonSerializable
*
* @throws \Exception
*/
public function getObjectSerialization() {
if ($this->object instanceof JsonSerializable) {
return $this->object->jsonSerialize();
} else {
throw new \Exception('jsonSerialize is not implemented on ' . get_class($this));
}
}
public function getPrimaryKey(): string {
return $this->primaryKey;
}
}