2020-03-30 03:33:16 +09:00
< ? php
2021-11-26 22:05:23 +09:00
declare ( strict_types = 1 );
2020-03-30 04:56:35 +09:00
// {{{ License
2020-05-21 01:53:53 +09:00
// This file is part of GNU social - https://www.gnu.org/software/social
2020-03-30 04:56:35 +09:00
//
// GNU social is free software: you can redistribute it and/or modify
2020-05-11 05:43:15 +09:00
// it under the terms of the GNU Affero General Public License as published by
2020-03-30 04:56:35 +09:00
// 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.
//
2020-05-11 05:43:15 +09:00
// You should have received a copy of the GNU Affero General Public License
2020-03-30 04:56:35 +09:00
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
// }}}
2020-03-30 03:33:16 +09:00
2020-08-15 15:18:23 +09:00
namespace App\Entity ;
2021-11-27 13:11:35 +09:00
use App\Core\Cache ;
use App\Core\DB\DB ;
2020-08-15 15:18:23 +09:00
use App\Core\Entity ;
use DateTimeInterface ;
2020-03-30 03:33:16 +09:00
/**
2021-09-18 11:22:27 +09:00
* Entity for List of actors
2021-12-20 02:09:00 +09:00
* This entity only makes sense when considered together with the ActorTag one .
* Because , every circle entry will be an ActorTag .
2020-03-30 03:33:16 +09:00
*
* @ 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
2021-02-20 08:29:43 +09:00
* @ author Hugo Sales < hugo @ hsal . es >
2021-11-27 13:11:35 +09:00
* @ author Diogo Peralta Cordeiro <@ diogo . site >
2021-02-20 08:29:43 +09:00
* @ copyright 2020 - 2021 Free Software Foundation , Inc http :// www . fsf . org
2020-03-30 03:33:16 +09:00
* @ license https :// www . gnu . org / licenses / agpl . html GNU AGPL v3 or later
*/
2021-09-18 11:22:27 +09:00
class ActorCircle extends Entity
2020-03-30 03:33:16 +09:00
{
2020-03-30 23:00:13 +09:00
// {{{ Autocode
2021-05-06 01:03:03 +09:00
// @codeCoverageIgnoreStart
2021-11-27 13:11:35 +09:00
private int $id ;
2020-03-31 00:13:51 +09:00
private int $tagger ;
private string $tag ;
private ? string $description ;
private ? bool $private ;
2021-12-27 00:12:06 +09:00
private \DateTimeInterface $created ;
private \DateTimeInterface $modified ;
2020-03-31 00:13:51 +09:00
2021-11-28 22:09:04 +09:00
public function setId ( int $id ) : self
2021-11-27 13:11:35 +09:00
{
$this -> id = $id ;
return $this ;
}
public function getId () : int
{
return $this -> id ;
}
2020-03-31 00:13:51 +09:00
public function setTagger ( int $tagger ) : self
{
$this -> tagger = $tagger ;
return $this ;
}
2020-08-09 01:11:18 +09:00
2020-03-31 00:13:51 +09:00
public function getTagger () : int
{
return $this -> tagger ;
}
public function setTag ( string $tag ) : self
{
2021-12-27 00:12:06 +09:00
$this -> tag = \mb_substr ( $tag , 0 , 64 );
2020-03-31 00:13:51 +09:00
return $this ;
}
2020-08-09 01:11:18 +09:00
2020-03-31 00:13:51 +09:00
public function getTag () : string
{
return $this -> tag ;
}
public function setDescription ( ? string $description ) : self
{
$this -> description = $description ;
return $this ;
}
2020-08-09 01:11:18 +09:00
2020-03-31 00:13:51 +09:00
public function getDescription () : ? string
{
return $this -> description ;
}
public function setPrivate ( ? bool $private ) : self
{
$this -> private = $private ;
return $this ;
}
2020-08-09 01:11:18 +09:00
2020-03-31 00:13:51 +09:00
public function getPrivate () : ? bool
{
return $this -> private ;
}
2021-12-27 00:12:06 +09:00
public function setCreated ( \DateTimeInterface $created ) : self
2020-03-31 00:13:51 +09:00
{
2020-07-01 03:20:50 +09:00
$this -> created = $created ;
2020-03-31 00:13:51 +09:00
return $this ;
}
2020-08-09 01:11:18 +09:00
2021-12-27 00:12:06 +09:00
public function getCreated () : \DateTimeInterface
2020-07-01 03:20:50 +09:00
{
return $this -> created ;
}
2020-05-12 02:39:12 +09:00
2021-12-27 00:12:06 +09:00
public function setModified ( \DateTimeInterface $modified ) : self
2020-03-31 00:13:51 +09:00
{
2020-07-01 03:20:50 +09:00
$this -> modified = $modified ;
return $this ;
}
2020-08-09 01:11:18 +09:00
2021-12-27 00:12:06 +09:00
public function getModified () : \DateTimeInterface
2020-07-01 03:20:50 +09:00
{
return $this -> modified ;
2020-03-31 00:13:51 +09:00
}
2021-05-06 01:03:03 +09:00
// @codeCoverageIgnoreEnd
2020-03-30 23:00:13 +09:00
// }}} Autocode
2020-03-30 03:33:16 +09:00
2021-11-28 22:09:04 +09:00
public function getActorTag ()
{
return Cache :: get (
" actor-tag- { $this -> getTag () } " ,
fn () => DB :: findBy ( 'actor_tag' , [ 'tagger' => $this -> getTagger (), 'canonical' => $this -> getTag ()], limit : 1 )[ 0 ], // TODO jank
);
}
2021-11-27 13:11:35 +09:00
public function getSubscribedActors ( ? int $offset = null , ? int $limit = null ) : array
{
return Cache :: get (
" circle- { $this -> getId () } " ,
2021-11-28 22:09:04 +09:00
fn () => DB :: dql (
<<< 'EOQ'
2021-11-27 13:12:44 +09:00
SELECT a
FROM App\Entity\Actor a
JOIN App\Entity\ActorCircleSubscription s
WITH a . id = s . actor_id
ORDER BY s . created DESC , a . id DESC
2021-11-27 13:11:35 +09:00
EOQ ,
2021-11-28 22:09:04 +09:00
options : [ 'offset' => $offset ,
'limit' => $limit , ],
),
2021-11-27 13:11:35 +09:00
);
}
2020-03-30 03:33:16 +09:00
public static function schemaDef () : array
{
return [
2021-09-18 11:22:27 +09:00
'name' => 'actor_circle' ,
2021-11-26 22:05:23 +09:00
'description' => 'a actor can have lists of actors, to separate their feed' ,
2020-07-01 01:26:40 +09:00
'fields' => [
2021-12-23 23:36:12 +09:00
'id' => [ 'type' => 'serial' , 'not null' => true , 'description' => 'unique identifier' ],
2021-12-20 02:09:00 +09:00
// An actor can be tagged by many actors
2021-12-23 23:36:12 +09:00
'tagger' => [ 'type' => 'int' , 'foreign key' => true , 'target' => 'Actor.id' , 'multiplicity' => 'many to one' , 'name' => 'actor_list_tagger_fkey' , 'not null' => true , 'description' => 'user making the tag' ],
2021-12-20 02:09:00 +09:00
// Many Actor Circles can reference (and probably will) an Actor Tag
'tag' => [ 'type' => 'varchar' , 'length' => 64 , 'foreign key' => true , 'target' => 'ActorTag.tag' , 'multiplicity' => 'many to one' , 'not null' => true , 'description' => 'actor tag' ], // Join with ActorTag // // so, Doctrine doesn't like that the target is not unique, even though the pair is
2021-02-23 06:34:59 +09:00
'description' => [ 'type' => 'text' , 'description' => 'description of the people tag' ],
'private' => [ 'type' => 'bool' , 'default' => false , 'description' => 'is this tag private' ],
2020-08-13 08:57:22 +09:00
'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' ],
2020-03-30 03:33:16 +09:00
],
2021-11-27 13:11:35 +09:00
'primary key' => [ 'id' ],
2021-03-12 07:16:17 +09:00
'indexes' => [
2021-09-18 11:22:27 +09:00
'actor_list_modified_idx' => [ 'modified' ],
'actor_list_tag_idx' => [ 'tag' ],
'actor_list_tagger_tag_idx' => [ 'tagger' , 'tag' ],
2021-12-23 23:36:12 +09:00
'actor_list_tagger_idx' => [ 'tagger' ],
2020-03-30 03:33:16 +09:00
],
];
}
2021-11-27 13:11:35 +09:00
public function __toString ()
{
return $this -> getTag ();
}
2020-03-31 03:19:44 +09:00
}