gnu-social/components/Group/Entity/GroupMember.php

146 lines
4.6 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\Group\Entity;
use App\Core\Entity;
use DateTimeInterface;
/**
* Entity for a Group Member
*
* @category DB
* @package GNUsocial
*
* @author Zach Copley <zach@status.net>
* @copyright 2010 StatusNet Inc.
* @author Mikael Nordfeldth <mmn@hethane.se>
* @copyright 2009-2014 Free Software Foundation, Inc http://www.fsf.org
* @author Hugo Sales <hugo@hsal.es>
* @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 GroupMember extends Entity
{
// {{{ Autocode
// @codeCoverageIgnoreStart
private int $group_id;
2021-09-18 11:22:27 +09:00
private int $actor_id;
private ?bool $is_admin = false;
private ?string $uri = null;
private DateTimeInterface $created;
private DateTimeInterface $modified;
public function setGroupId(int $group_id): self
{
$this->group_id = $group_id;
return $this;
}
public function getGroupId(): int
{
return $this->group_id;
}
2021-09-18 11:22:27 +09:00
public function setActorId(int $actor_id): self
{
2021-09-18 11:22:27 +09:00
$this->actor_id = $actor_id;
return $this;
}
2021-09-18 11:22:27 +09:00
public function getActorId(): int
{
2021-09-18 11:22:27 +09:00
return $this->actor_id;
}
public function setIsAdmin(?bool $is_admin): self
{
$this->is_admin = $is_admin;
return $this;
}
public function getIsAdmin(): ?bool
{
return $this->is_admin;
}
public function setUri(?string $uri): self
{
$this->uri = \is_null($uri) ? null : mb_substr($uri, 0, 191);
return $this;
}
public function getUri(): ?string
{
return $this->uri;
}
public function setCreated(DateTimeInterface $created): self
{
$this->created = $created;
return $this;
}
public function getCreated(): DateTimeInterface
{
return $this->created;
}
public function setModified(DateTimeInterface $modified): self
{
$this->modified = $modified;
return $this;
}
public function getModified(): DateTimeInterface
{
return $this->modified;
}
// @codeCoverageIgnoreEnd
// }}} Autocode
public static function schemaDef(): array
{
return [
'name' => 'group_member',
'fields' => [
'group_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'Actor.id', 'multiplicity' => 'one to one', 'name' => 'group_member_group_id_fkey', 'not null' => true, 'description' => 'foreign key to group table'],
2021-09-18 11:22:27 +09:00
'actor_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'Actor.id', 'multiplicity' => 'one to one', 'name' => 'group_member_actor_id_fkey', 'not null' => true, 'description' => 'foreign key to actor table'],
'is_admin' => ['type' => 'bool', 'default' => false, 'description' => 'is this actor an admin?'],
'uri' => ['type' => 'varchar', 'length' => 191, 'description' => 'universal identifier'],
'created' => ['type' => 'datetime', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was created'],
'modified' => ['type' => 'timestamp', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was modified'],
],
2021-09-18 11:22:27 +09:00
'primary key' => ['group_id', 'actor_id'],
'unique keys' => [
'group_member_uri_key' => ['uri'],
],
'indexes' => [
2021-09-18 11:22:27 +09:00
'group_member_actor_id_idx' => ['actor_id'],
'group_member_created_idx' => ['created'],
'group_member_actor_id_created_idx' => ['actor_id', 'created'],
'group_member_group_id_created_idx' => ['group_id', 'created'],
],
];
}
}