gnu-social/components/Attachment/Entity/AttachmentToNote.php

162 lines
4.8 KiB
PHP
Raw Normal View History

<?php
// {{{ 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\Attachment\Entity;
2021-12-10 02:38:04 +00:00
use App\Core\Cache;
use App\Core\DB\DB;
use App\Core\Entity;
use DateTimeInterface;
/**
2021-04-15 23:28:28 +01:00
* Entity for relating a attachment to a post
*
* @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
*/
2021-04-15 23:28:28 +01:00
class AttachmentToNote extends Entity
{
// {{{ Autocode
// @codeCoverageIgnoreStart
2021-04-15 23:28:28 +01:00
private int $attachment_id;
private int $note_id;
private ?string $title;
private \DateTimeInterface $modified;
2021-04-15 23:28:28 +01:00
public function setAttachmentId(int $attachment_id): self
{
2021-04-15 23:28:28 +01:00
$this->attachment_id = $attachment_id;
return $this;
}
2021-04-15 23:28:28 +01:00
public function getAttachmentId(): int
{
2021-04-15 23:28:28 +01:00
return $this->attachment_id;
}
public function setNoteId(int $note_id): self
{
$this->note_id = $note_id;
return $this;
}
public function getNoteId(): int
{
return $this->note_id;
}
public function setTitle(?string $title): self
{
$this->title = $title;
return $this;
}
public function getTitle(): ?string
{
return $this->title;
}
public function setModified(DateTimeInterface $modified): self
{
$this->modified = $modified;
return $this;
}
public function getModified(): DateTimeInterface
{
return $this->modified;
}
// @codeCoverageIgnoreEnd
// }}} Autocode
2021-12-10 02:38:04 +00:00
/**
* @param int $note_id
* @param int $attachment_id
* @return mixed
*/
public static function removeWhere(int $note_id, int $attachment_id): mixed
{
return DB::dql(
<<<'EOF'
DELETE FROM attachment_to_note atn
WHERE (atn.attachment_id = :attachment_id
OR atn.note_id = :note_id)
EOF,
['note_id' => $note_id, 'attachment_id' => $attachment_id],
);
}
/**
* @param int $note_id
* @return mixed
*/
public static function removeWhereNoteId(int $note_id): mixed
{
return DB::dql(
<<<'EOF'
DELETE FROM attachment_to_note atn
WHERE atn.note_id = :note_id
EOF,
['note_id' => $note_id],
);
}
/**
* @param int $attachment_id
* @return mixed
*/
public static function removeWhereAttachmentId(int $attachment_id): mixed
{
return DB::dql(
<<<'EOF'
DELETE FROM attachment_to_note atn
WHERE atn.attachment_id = :attachment_id
EOF,
['attachment_id' => $attachment_id],
);
}
public static function schemaDef(): array
{
return [
2021-04-15 23:28:28 +01:00
'name' => 'attachment_to_note',
'fields' => [
2021-04-15 23:28:28 +01:00
'attachment_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'Attachment.id', 'multiplicity' => 'one to one', 'name' => 'attachment_to_note_attachment_id_fkey', 'not null' => true, 'description' => 'id of attachment'],
'note_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'Note.id', 'multiplicity' => 'one to one', 'name' => 'attachment_to_note_note_id_fkey', 'not null' => true, 'description' => 'id of the note it belongs to'],
'title' => ['type' => 'text', 'description' => 'title of resource when available'],
2021-04-15 23:28:28 +01:00
'modified' => ['type' => 'timestamp', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was modified'],
],
2021-04-15 23:28:28 +01:00
'primary key' => ['attachment_id', 'note_id'],
'indexes' => [
2021-04-15 23:28:28 +01:00
'attachment_id_idx' => ['attachment_id'],
'note_id_idx' => ['note_id'],
],
];
}
}