2020-09-04 15:17:10 +01:00
< ? php
2021-10-10 09:26:18 +01:00
declare ( strict_types = 1 );
2020-09-04 15:17:10 +01:00
// {{{ 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/>.
// }}}
2021-03-12 13:46:00 +00:00
namespace Plugin\Favourite\Entity ;
2020-09-04 15:17:10 +01:00
2022-01-08 17:15:00 +00:00
use App\Core\Cache ;
2021-12-29 17:54:02 +00:00
use App\Core\DB\DB ;
2020-09-04 15:17:10 +01:00
use App\Core\Entity ;
2022-01-08 17:15:00 +00:00
use App\Entity\Actor ;
use App\Entity\LocalUser ;
2021-12-26 06:09:17 +00:00
use App\Entity\Note ;
2020-09-04 15:17:10 +01:00
use DateTimeInterface ;
2021-12-29 17:54:02 +00:00
class NoteFavourite extends Entity
2020-09-04 15:17:10 +01:00
{
// {{{ Autocode
2021-05-05 17:03:03 +01:00
// @codeCoverageIgnoreStart
2020-09-04 15:17:10 +01:00
private int $note_id ;
2021-09-18 03:22:27 +01:00
private int $actor_id ;
2021-10-10 09:26:18 +01:00
private DateTimeInterface $created ;
private DateTimeInterface $modified ;
2020-09-04 15:17:10 +01:00
public function setNoteId ( int $note_id ) : self
{
$this -> note_id = $note_id ;
return $this ;
}
public function getNoteId () : int
{
return $this -> note_id ;
}
2021-09-18 03:22:27 +01:00
public function setActorId ( int $actor_id ) : self
2020-09-04 15:17:10 +01:00
{
2021-09-18 03:22:27 +01:00
$this -> actor_id = $actor_id ;
2020-09-04 15:17:10 +01:00
return $this ;
}
2021-09-18 03:22:27 +01:00
public function getActorId () : int
2020-09-04 15:17:10 +01:00
{
2021-09-18 03:22:27 +01:00
return $this -> actor_id ;
2020-09-04 15:17:10 +01:00
}
2021-05-05 17:03:03 +01:00
public function setCreated ( DateTimeInterface $created ) : self
2020-09-04 15:17:10 +01:00
{
$this -> created = $created ;
return $this ;
}
2021-05-05 17:03:03 +01:00
public function getCreated () : DateTimeInterface
2020-09-04 15:17:10 +01:00
{
return $this -> created ;
}
2021-05-05 17:03:03 +01:00
public function setModified ( DateTimeInterface $modified ) : self
2020-09-04 15:17:10 +01:00
{
$this -> modified = $modified ;
return $this ;
}
2021-05-05 17:03:03 +01:00
public function getModified () : DateTimeInterface
2020-09-04 15:17:10 +01:00
{
return $this -> modified ;
}
2021-02-20 21:01:08 +00:00
2021-05-05 17:03:03 +01:00
// @codeCoverageIgnoreEnd
2020-09-04 15:17:10 +01:00
// }}} Autocode
2022-01-08 17:15:00 +00:00
public static function cacheKeys ( int | Note $note_id , int | Actor | LocalUser | null $actor_id = null ) : array
{
$note_id = \is_int ( $note_id ) ? $note_id : $note_id -> getId ();
$actor_id = \is_null ( $actor_id ) ? null : ( \is_int ( $actor_id ) ? $actor_id : $actor_id -> getId ());
return [
'favourite' => " note-favourite- { $note_id } - { $actor_id } " ,
'favourites' => " note-favourites- { $note_id } " ,
'favourites-actors' => " note-favourites-actors- { $note_id } " ,
];
}
2022-01-02 15:55:10 +00:00
public static function getNoteFavourites ( Note $note ) : array
{
2022-01-08 17:15:00 +00:00
return Cache :: getList (
self :: cacheKeys ( $note )[ 'favourites' ],
fn () => DB :: findBy ( 'note_favourite' , [ 'note_id' => $note -> getId ()]),
);
2022-01-02 15:55:10 +00:00
}
2021-12-29 17:54:02 +00:00
public static function getNoteFavouriteActors ( Note $note ) : array
{
2022-01-08 17:15:00 +00:00
return Cache :: getList (
self :: cacheKeys ( $note )[ 'favourites-actors' ],
fn () => DB :: dql (
<<< 'EOF'
2022-03-23 13:18:44 +00:00
SELECT a FROM actor AS a
INNER JOIN note_favourite AS nf
WITH a . id = nf . actor_id
WHERE nf . note_id = : note_id
ORDER BY nf . created DESC
2022-01-08 17:15:00 +00:00
EOF ,
[ 'note_id' => $note -> getId ()],
),
2021-12-29 17:54:02 +00:00
);
}
2022-03-08 00:21:12 +00:00
public static function schemaDef () : array
2020-09-04 15:17:10 +01:00
{
return [
2021-12-29 17:54:02 +00:00
'name' => 'note_favourite' ,
2020-09-04 15:17:10 +01:00
'fields' => [
2021-09-18 03:22:27 +01:00
'note_id' => [ 'type' => 'int' , 'foreign key' => true , 'target' => 'App\Entity\Note.id' , 'multiplicity' => 'one to one' , 'not null' => true , 'description' => 'note that is the favorite of' ],
'actor_id' => [ 'type' => 'int' , 'foreign key' => true , 'target' => 'App\Entity\Actor.id' , 'multiplicity' => 'one to one' , 'not null' => true , 'description' => 'actor who favourited this note' ], // note: formerly referenced notice.id, but we can now record remote users' favorites
'created' => [ 'type' => 'datetime' , 'not null' => true , 'description' => 'date this record was created' ],
'modified' => [ 'type' => 'timestamp' , 'not null' => true , 'description' => 'date this record was modified' ],
2020-09-04 15:17:10 +01:00
],
2022-02-04 16:03:49 +00:00
'primary key' => [ 'note_id' , 'actor_id' ],
'foreign keys' => [
'note_id_to_id_fkey' => [ 'note' , [ 'note_id' => 'id' ]],
'actor_reply_to_id_fkey' => [ 'actor' , [ 'actor_id' => 'id' ]],
],
'indexes' => [
2020-09-04 15:17:10 +01:00
'fave_note_id_idx' => [ 'note_id' ],
2021-09-18 03:22:27 +01:00
'fave_actor_id_idx' => [ 'actor_id' , 'modified' ],
2020-09-04 15:17:10 +01:00
'fave_modified_idx' => [ 'modified' ],
],
];
}
2021-02-22 21:34:59 +00:00
}