2020-03-29 19:33:16 +01:00
< ? php
2021-11-28 11:14:58 +00:00
declare ( strict_types = 1 );
2020-08-13 02:35:01 +01:00
// {{{ License/
2020-05-20 17:53:53 +01:00
// This file is part of GNU social - https://www.gnu.org/software/social
2020-03-29 20:56:35 +01:00
//
// GNU social is free software: you can redistribute it and/or modify
2020-05-10 21:43:15 +01:00
// it under the terms of the GNU Affero General Public License as published by
2020-03-29 20:56:35 +01: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-10 21:43:15 +01:00
// You should have received a copy of the GNU Affero General Public License
2020-03-29 20:56:35 +01:00
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
// }}}
2020-03-29 19:33:16 +01:00
2020-08-15 07:18:23 +01:00
namespace App\Entity ;
use App\Core\Entity ;
2021-11-28 18:58:56 +00:00
use App\Core\Router\Router ;
2021-09-18 14:09:14 +01:00
use Component\Tag\Tag ;
2020-08-15 07:18:23 +01:00
use DateTimeInterface ;
2020-03-29 19:33:16 +01: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-19 23:29:43 +00:00
* @ author Hugo Sales < hugo @ hsal . es >
* @ copyright 2020 - 2021 Free Software Foundation , Inc http :// www . fsf . org
2020-03-29 19:33:16 +01:00
* @ license https :// www . gnu . org / licenses / agpl . html GNU AGPL v3 or later
*/
2021-02-22 21:34:59 +00:00
class NoteTag extends Entity
2020-03-29 19:33:16 +01:00
{
2020-03-30 15:00:13 +01:00
// {{{ Autocode
2021-05-05 17:03:03 +01:00
// @codeCoverageIgnoreStart
2020-03-30 16:13:51 +01:00
private string $tag ;
2021-09-18 14:09:14 +01:00
private string $canonical ;
2020-08-13 02:35:01 +01:00
private int $note_id ;
2021-11-28 11:14:58 +00:00
private DateTimeInterface $created ;
2020-03-30 16:13:51 +01:00
public function setTag ( string $tag ) : self
{
$this -> tag = $tag ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2020-03-30 16:13:51 +01:00
public function getTag () : string
{
return $this -> tag ;
}
2021-09-18 14:09:14 +01:00
public function setCanonical ( string $canonical ) : self
{
$this -> canonical = $canonical ;
return $this ;
}
public function getCanonical () : string
{
return $this -> canonical ;
}
2020-08-13 02:35:01 +01:00
public function setNoteId ( int $note_id ) : self
2020-03-30 16:13:51 +01:00
{
2020-08-13 02:35:01 +01:00
$this -> note_id = $note_id ;
2020-03-30 16:13:51 +01:00
return $this ;
}
2020-08-08 17:11:18 +01:00
2020-08-13 02:35:01 +01:00
public function getNoteId () : int
2020-03-30 16:13:51 +01:00
{
2020-08-13 02:35:01 +01:00
return $this -> note_id ;
2020-03-30 16:13:51 +01:00
}
2021-05-05 17:03:03 +01:00
public function setCreated ( DateTimeInterface $created ) : self
2020-03-30 16:13:51 +01:00
{
$this -> created = $created ;
return $this ;
}
2020-08-08 17:11:18 +01:00
2021-05-05 17:03:03 +01:00
public function getCreated () : DateTimeInterface
2020-03-30 16:13:51 +01:00
{
return $this -> created ;
}
2021-05-05 17:03:03 +01:00
// @codeCoverageIgnoreEnd
2020-03-30 15:00:13 +01:00
// }}} Autocode
2020-03-29 19:33:16 +01:00
2021-11-28 18:58:56 +00:00
public function getUrl ( ? Actor $actor = null ) : string
{
$params = [ 'tag' => $this -> getCanonical ()];
if ( ! \is_null ( $actor )) {
$params [ 'lang' ] = $actor -> getTopLanguage () -> getLocale ();
}
return Router :: url ( 'single_note_tag' , $params );
}
2020-03-29 19:33:16 +01:00
public static function schemaDef () : array
{
return [
2021-02-22 21:34:59 +00:00
'name' => 'note_tag' ,
2020-08-13 00:57:22 +01:00
'description' => 'Hash tags on notes' ,
2020-03-29 19:33:16 +01:00
'fields' => [
2021-09-18 14:09:14 +01:00
'tag' => [ 'type' => 'varchar' , 'length' => Tag :: MAX_TAG_LENGTH , 'not null' => true , 'description' => 'hash tag associated with this note' ],
2021-11-28 11:14:58 +00:00
'canonical' => [ 'type' => 'varchar' , 'length' => Tag :: MAX_TAG_LENGTH , 'not null' => true , 'description' => 'ascii slug of tag' ],
2021-09-18 14:09:14 +01:00
'note_id' => [ 'type' => 'int' , 'foreign key' => true , 'target' => 'Note.id' , 'multiplicity' => 'one to one' , 'not null' => true , 'description' => 'foreign key to tagged note' ],
'created' => [ 'type' => 'datetime' , 'not null' => true , 'default' => 'CURRENT_TIMESTAMP' , 'description' => 'date this record was modified' ],
2020-03-29 19:33:16 +01:00
],
2021-02-22 21:34:59 +00:00
'primary key' => [ 'tag' , 'note_id' ],
'indexes' => [
2020-08-13 00:57:22 +01:00
'note_tag_created_idx' => [ 'created' ],
'note_tag_note_id_idx' => [ 'note_id' ],
2021-09-18 14:09:14 +01:00
'note_tag_canonical_idx' => [ 'canonical' ],
2020-08-13 00:57:22 +01:00
'note_tag_tag_created_note_id_idx' => [ 'tag' , 'created' , 'note_id' ],
2020-03-29 19:33:16 +01:00
],
];
}
2020-06-30 17:26:40 +01:00
}