2020-03-30 03:33:16 +09:00
< ? php
2021-11-28 20:14:58 +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
namespace App\Entity ;
2021-12-06 02:50:15 +09:00
use App\Core\Cache ;
2021-11-27 13:11:35 +09:00
use App\Core\DB\DB ;
2020-08-15 15:08:52 +09:00
use App\Core\Entity ;
2021-11-28 22:09:04 +09:00
use App\Core\Router\Router ;
2021-11-28 20:14:58 +09:00
use Component\Tag\Tag ;
2020-05-11 05:43:15 +09:00
use DateTimeInterface ;
2020-03-30 03:33:16 +09:00
/**
2021-09-18 11:22:27 +09:00
* Entity for Actor Tag
2021-12-20 02:09:00 +09:00
* This entity represents the relationship between an Actor and a Tag .
* That relationship works as follows :
* An Actor A tags an Actor B ( which can be A - a self tag ) .
* For every tagging that happens between two actors , a new ActorTag is born .
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-12-20 02:09:00 +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 ActorTag 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
2020-03-31 00:13:51 +09:00
private int $tagger ;
private int $tagged ;
private string $tag ;
2021-11-28 20:14:58 +09:00
private string $canonical ;
2021-12-06 02:51:16 +09:00
private bool $use_canonical ;
2021-11-28 20:14:58 +09:00
private DateTimeInterface $modified ;
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 setTagged ( int $tagged ) : self
{
$this -> tagged = $tagged ;
return $this ;
}
2020-08-09 01:11:18 +09:00
2020-03-31 00:13:51 +09:00
public function getTagged () : int
{
return $this -> tagged ;
}
public function setTag ( string $tag ) : self
{
$this -> tag = $tag ;
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 ;
}
2021-11-28 20:14:58 +09:00
public function setCanonical ( string $canonical ) : self
{
$this -> canonical = $canonical ;
return $this ;
}
public function getCanonical () : string
{
return $this -> canonical ;
}
2021-12-06 02:51:16 +09:00
public function setUseCanonical ( bool $use_canonical ) : self
{
$this -> use_canonical = $use_canonical ;
return $this ;
}
public function getUseCanonical () : bool
{
return $this -> use_canonical ;
}
2021-05-06 01:03:03 +09:00
public function setModified ( DateTimeInterface $modified ) : self
2020-03-31 00:13:51 +09:00
{
$this -> modified = $modified ;
return $this ;
}
2020-08-09 01:11:18 +09:00
2021-05-06 01:03:03 +09:00
public function getModified () : DateTimeInterface
2020-03-31 00:13:51 +09:00
{
return $this -> modified ;
}
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-12-06 02:50:15 +09:00
public static function getByActorId ( int $actor_id ) : array
{
2021-12-23 23:04:00 +09:00
return Cache :: getList ( Actor :: cacheKeys ( $actor_id )[ 'tags' ], fn () => DB :: dql ( 'select at from actor_tag at join actor a with a.id = at.tagger where a.id = :id' , [ 'id' => $actor_id ]));
2021-12-06 02:50:15 +09:00
}
2021-11-28 22:09:04 +09:00
public function getUrl ( ? Actor $actor = null ) : string
{
2021-12-10 01:34:07 +09:00
$params = [ 'canon' => $this -> getCanonical (), 'tag' => $this -> getTag ()];
2021-11-28 22:09:04 +09:00
if ( ! \is_null ( $actor )) {
$params [ 'lang' ] = $actor -> getTopLanguage () -> getLocale ();
}
return Router :: url ( 'single_actor_tag' , $params );
}
2020-03-30 03:33:16 +09:00
public static function schemaDef () : array
{
return [
2021-09-18 11:22:27 +09:00
'name' => 'actor_tag' ,
2020-03-30 03:33:16 +09:00
'fields' => [
2021-12-06 02:51:16 +09:00
'tagger' => [ 'type' => 'int' , 'foreign key' => true , 'target' => 'Actor.id' , 'multiplicity' => 'one to one' , 'name' => 'actor_tag_tagger_fkey' , 'not null' => true , 'description' => 'actor making the tag' ],
'tagged' => [ 'type' => 'int' , 'foreign key' => true , 'target' => 'Actor.id' , 'multiplicity' => 'one to one' , 'name' => 'actor_tag_tagged_fkey' , 'not null' => true , 'description' => 'actor tagged' ],
'tag' => [ 'type' => 'varchar' , 'length' => Tag :: MAX_TAG_LENGTH , 'not null' => true , 'description' => 'hash tag associated with this actor' ],
'canonical' => [ 'type' => 'varchar' , 'length' => Tag :: MAX_TAG_LENGTH , 'not null' => true , 'description' => 'ascii slug of tag' ],
'use_canonical' => [ 'type' => 'bool' , 'not null' => true , 'description' => 'whether the user wanted to block canonical tags' ],
'modified' => [ 'type' => 'timestamp' , 'not null' => true , 'default' => 'CURRENT_TIMESTAMP' , 'description' => 'date this record was modified' ],
2020-03-30 03:33:16 +09:00
],
2021-12-20 02:09:00 +09:00
'primary key' => [ 'tagger' , 'tagged' , 'tag' , 'use_canonical' ],
2021-02-23 06:34:59 +09:00
'indexes' => [
2021-12-23 23:04:00 +09:00
'actor_tag_modified_idx' => [ 'modified' ],
2021-12-20 02:09:00 +09:00
'actor_tag_tagger_tag_idx' => [ 'tagger' , 'tag' ], // For Circles
2021-12-23 23:04:00 +09:00
'actor_tag_tagged_idx' => [ 'tagged' ],
2020-03-30 03:33:16 +09:00
],
];
}
2021-12-06 03:34:33 +09:00
public function __toString () : string
{
return $this -> getTag ();
}
2020-07-01 01:26:40 +09:00
}