gnu-social/components/Conversation/Entity/Conversation.php

102 lines
3.0 KiB
PHP
Raw Normal View History

<?php
declare(strict_types = 1);
// {{{ License
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
// }}}
namespace Component\Conversation\Entity;
use App\Core\DB;
use App\Core\Entity;
use App\Core\Router\Router;
/**
* Entity class for Conversations
*
* @category DB
* @package GNUsocial
*
* @author Zach Copley <zach@status.net>
* @author Mikael Nordfeldth <mmn@hethane.se>
* @copyright 2010 StatusNet Inc.
* @copyright 2009-2014 Free Software Foundation, Inc http://www.fsf.org
* @author Hugo Sales <hugo@hsal.es>
* @author Eliseu Amaro <mail@eliseuama.ro>
* @copyright 2020-2021 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
class Conversation extends Entity
{
// {{{ Autocode
// @codeCoverageIgnoreStart
private int $id;
private int $initial_note_id;
public function setId(int $id): self
{
$this->id = $id;
return $this;
}
public function getId(): int
{
return $this->id;
}
public function setInitialNoteId(int $initial_note_id): self
{
$this->initial_note_id = $initial_note_id;
return $this;
}
public function getInitialNoteId(): int
{
return $this->initial_note_id;
}
// @codeCoverageIgnoreEnd
// }}} Autocode
public function getUrl(int $type = Router::ABSOLUTE_URL): string
{
return Router::url('conversation', ['conversation_id' => $this->getId()], $type);
}
public function getUri(): string
{
return $this->getUrl(type: Router::ABSOLUTE_URL);
}
public static function schemaDef(): array
{
return [
'name' => 'conversation',
'fields' => [
'id' => ['type' => 'serial', 'not null' => true, 'description' => 'Serial identifier, since any additional meaning would require updating its value for every reply upon receiving a new aparent root'],
'initial_note_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'Note.id', 'multiplicity' => 'one to one', 'not null' => true, 'description' => 'Initial note seen on this host for this conversation'],
],
'primary key' => ['id'],
'foreign keys' => [
'initial_note_id_to_id_fkey' => ['note', ['initial_note_id' => 'id']],
],
];
}
}