2020-03-30 03:33:16 +09:00
< ? php
2021-11-28 20:14:58 +09:00
declare ( strict_types = 1 );
2020-08-13 10:35:01 +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
2022-01-05 07:20:12 +09:00
namespace Component\Tag\Entity ;
2020-08-15 15:18:23 +09:00
2021-12-04 21:56:37 +09:00
use App\Core\Cache ;
use App\Core\DB\DB ;
2020-08-15 15:18:23 +09:00
use App\Core\Entity ;
2021-11-29 03:58:56 +09:00
use App\Core\Router\Router ;
2022-01-05 07:20:12 +09:00
use App\Entity\Actor ;
use App\Entity\Note ;
use Component\Language\Entity\Language ;
2021-09-18 22:09:14 +09:00
use Component\Tag\Tag ;
2020-08-15 15:18:23 +09:00
use DateTimeInterface ;
2020-03-30 03:33:16 +09:00
/**
* Entity for Notice Tag
*
* @ 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 >
2022-01-05 07:20:12 +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-02-23 06:34:59 +09:00
class NoteTag 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 string $tag ;
2021-09-18 22:09:14 +09:00
private string $canonical ;
2020-08-13 10:35:01 +09:00
private int $note_id ;
2021-12-04 21:56:37 +09:00
private bool $use_canonical ;
2021-12-27 06:32:09 +09:00
private ? int $language_id = null ;
2022-01-05 07:20:12 +09:00
private DateTimeInterface $created ;
2020-03-31 00:13:51 +09:00
public function setTag ( string $tag ) : self
{
2022-01-05 07:20:12 +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 ;
}
2021-09-18 22:09:14 +09:00
public function setCanonical ( string $canonical ) : self
{
2022-01-05 07:20:12 +09:00
$this -> canonical = mb_substr ( $canonical , 0 , 64 );
2021-09-18 22:09:14 +09:00
return $this ;
}
public function getCanonical () : string
{
return $this -> canonical ;
}
2020-08-13 10:35:01 +09:00
public function setNoteId ( int $note_id ) : self
2020-03-31 00:13:51 +09:00
{
2020-08-13 10:35:01 +09:00
$this -> note_id = $note_id ;
2020-03-31 00:13:51 +09:00
return $this ;
}
2020-08-09 01:11:18 +09:00
2020-08-13 10:35:01 +09:00
public function getNoteId () : int
2020-03-31 00:13:51 +09:00
{
2020-08-13 10:35:01 +09:00
return $this -> note_id ;
2020-03-31 00:13:51 +09:00
}
2021-12-04 21:56:37 +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-12-27 00:12:06 +09:00
public function setLanguageId ( ? int $language_id ) : self
2021-12-26 05:27:10 +09:00
{
$this -> language_id = $language_id ;
return $this ;
}
2021-12-27 00:12:06 +09:00
public function getLanguageId () : ? int
2021-12-26 05:27:10 +09:00
{
return $this -> language_id ;
}
2022-01-05 07:20:12 +09:00
public function setCreated ( DateTimeInterface $created ) : self
2020-03-31 00:13:51 +09:00
{
$this -> created = $created ;
return $this ;
}
2020-08-09 01:11:18 +09:00
2022-01-05 07:20:12 +09:00
public function getCreated () : DateTimeInterface
2020-03-31 00:13:51 +09:00
{
return $this -> created ;
}
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-04 23:07:15 +09:00
public static function cacheKey ( int | Note $note_id )
{
if ( ! \is_int ( $note_id )) {
$note_id = $note_id -> getId ();
}
return " note-tags- { $note_id } " ;
}
2021-12-05 04:58:00 +09:00
public static function getByNoteId ( int $note_id ) : array
2021-12-04 21:56:37 +09:00
{
2022-01-05 07:20:12 +09:00
return Cache :: getList ( self :: cacheKey ( $note_id ), fn () => DB :: dql ( 'SELECT nt FROM note_tag AS nt JOIN note AS n WITH n.id = nt.note_id WHERE n.id = :id' , [ 'id' => $note_id ]));
2021-12-04 21:56:37 +09:00
}
2021-12-25 06:02:02 +09:00
public function getUrl ( ? Actor $actor = null , int $type = Router :: ABSOLUTE_PATH ) : string
2021-11-29 03:58:56 +09:00
{
2022-01-05 07:20:12 +09:00
$params [ 'tag' ] = $this -> getTag ();
if ( \is_null ( $this -> getLanguageId ())) {
if ( ! \is_null ( $actor )) {
$params [ 'locale' ] = $actor -> getTopLanguage () -> getLocale ();
}
} else {
$params [ 'locale' ] = Language :: getById ( $this -> getLanguageId ()) -> getLocale ();
}
if ( $this -> getUseCanonical ()) {
$params [ 'canonical' ] = $this -> getCanonical ();
2021-11-29 03:58:56 +09:00
}
2022-01-05 07:20:12 +09:00
2021-12-25 06:02:02 +09:00
return Router :: url ( id : 'single_note_tag' , args : $params , type : $type );
2021-11-29 03:58:56 +09:00
}
2020-03-30 03:33:16 +09:00
public static function schemaDef () : array
{
return [
2021-02-23 06:34:59 +09:00
'name' => 'note_tag' ,
2020-08-13 08:57:22 +09:00
'description' => 'Hash tags on notes' ,
2020-03-30 03:33:16 +09:00
'fields' => [
2022-01-05 07:20:12 +09:00
'note_id' => [ 'type' => 'int' , 'foreign key' => true , 'target' => 'Note.id' , 'multiplicity' => 'one to one' , 'not null' => true , 'description' => 'foreign key to tagged note' ],
2021-12-04 21:56:37 +09:00
'tag' => [ 'type' => 'varchar' , 'length' => Tag :: MAX_TAG_LENGTH , 'not null' => true , 'description' => 'hash tag associated with this note' ],
'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 use canonical tags in this note. Separate for blocks' ],
2021-12-26 05:27:10 +09:00
'language_id' => [ 'type' => 'int' , 'not null' => false , 'foreign key' => true , 'target' => 'Language.id' , 'multiplicity' => 'many to many' , 'description' => 'the language this entry refers to' ],
2021-12-04 21:56:37 +09:00
'created' => [ 'type' => 'datetime' , 'not null' => true , 'default' => 'CURRENT_TIMESTAMP' , 'description' => 'date this record was modified' ],
2020-03-30 03:33:16 +09:00
],
2022-01-05 07:20:12 +09:00
'primary key' => [ 'note_id' , 'tag' ], // No need to require language in this association because all the related tags will be in the note's language already
2021-02-23 06:34:59 +09:00
'indexes' => [
2020-08-13 08:57:22 +09:00
'note_tag_created_idx' => [ 'created' ],
'note_tag_note_id_idx' => [ 'note_id' ],
2022-01-05 07:20:12 +09:00
'note_tag_tag_language_id_idx' => [ 'tag' , 'language_id' ],
2020-08-13 08:57:22 +09:00
'note_tag_tag_created_note_id_idx' => [ 'tag' , 'created' , 'note_id' ],
2020-03-30 03:33:16 +09:00
],
];
}
2020-07-01 01:26:40 +09:00
}