2021-10-28 09:26:16 +09:00
< ? php
declare ( strict_types = 1 );
// {{{ 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/>.
// }}}
namespace App\Entity ;
2021-11-28 22:09:04 +09:00
use App\Core\Cache ;
2021-10-28 09:26:16 +09:00
use App\Core\DB\DB ;
use App\Core\Entity ;
2021-11-28 22:09:04 +09:00
use App\Util\Common ;
2021-10-28 09:26:16 +09:00
/**
* Entity for actor languages
*
* @ category DB
* @ package GNUsocial
*
* @ author Hugo Sales < hugo @ hsal . es >
* @ copyright 2021 Free Software Foundation , Inc http :// www . fsf . org
* @ license https :// www . gnu . org / licenses / agpl . html GNU AGPL v3 or later
*/
class ActorLanguage extends Entity
{
// {{{ Autocode
// @codeCoverageIgnoreStart
private int $actor_id ;
private int $language_id ;
2021-11-16 02:00:58 +09:00
private int $ordering ;
2021-10-28 09:26:16 +09:00
public function setActorId ( int $actor_id ) : self
{
$this -> actor_id = $actor_id ;
return $this ;
}
public function getActorId () : int
{
return $this -> actor_id ;
}
public function setLanguageId ( int $language_id ) : self
{
$this -> language_id = $language_id ;
return $this ;
}
public function getLanguageId () : int
{
return $this -> language_id ;
}
2021-11-02 19:42:21 +09:00
2021-11-16 02:00:58 +09:00
public function getOrdering () : int
2021-11-02 19:42:21 +09:00
{
2021-11-16 02:00:58 +09:00
return $this -> ordering ;
2021-11-02 19:42:21 +09:00
}
2021-11-16 02:00:58 +09:00
public function setOrdering ( int $ordering ) : self
2021-11-02 19:42:21 +09:00
{
2021-11-16 02:00:58 +09:00
$this -> ordering = $ordering ;
2021-11-02 19:42:21 +09:00
return $this ;
}
2021-10-28 09:26:16 +09:00
// @codeCoverageIgnoreEnd
// }}} Autocode
2021-11-28 22:09:04 +09:00
public static function collectionCacheKey ( LocalUser | Actor $actor , ? Actor $context = null )
2021-11-16 02:00:58 +09:00
{
2021-11-28 22:09:04 +09:00
return 'actor-' . $actor -> getId () . '-langs' . ( ! \is_null ( $context ) ? '-cxt-' . $context -> getId () : '' );
2021-11-16 02:00:58 +09:00
}
public static function normalizeOrdering ( LocalUser | Actor $actor )
{
$langs = DB :: dql ( 'select l.locale, al.ordering, l.id from language l join actor_language al with l.id = al.language_id where al.actor_id = :id order by al.ordering ASC' , [ 'id' => $actor -> getId ()]);
usort ( $langs , fn ( $l , $r ) => [ $l [ 'ordering' ], $l [ 'locale' ]] <=> [ $r [ 'ordering' ], $r [ 'locale' ]]);
foreach ( $langs as $order => $l ) {
$actor_lang = DB :: getReference ( 'actor_language' , [ 'actor_id' => $actor -> getId (), 'language_id' => $l [ 'id' ]]);
$actor_lang -> setOrdering ( $order + 1 );
}
}
2021-11-28 22:09:04 +09:00
/**
2021-12-01 21:07:43 +09:00
* @ return Language []
2021-11-28 22:09:04 +09:00
*/
public static function getActorLanguages ( LocalUser | Actor $actor , ? Actor $context ) : array
{
$id = $context ? -> getId () ? ? $actor -> getId ();
return Cache :: getList (
self :: collectionCacheKey ( $actor , context : $context ),
fn () => DB :: dql (
'select l from actor_language al join language l with al.language_id = l.id where al.actor_id = :id order by al.ordering ASC' ,
[ 'id' => $id ],
),
2021-12-05 04:58:00 +09:00
) ? : [ Language :: getByLocale ( Common :: config ( 'site' , 'language' ))];
2021-11-28 22:09:04 +09:00
}
2021-10-28 09:26:16 +09:00
public static function schemaDef () : array
{
return [
'name' => 'actor_language' ,
'description' => 'join table where one actor can have many languages' ,
'fields' => [
2021-11-09 05:18:50 +09:00
'actor_id' => [ 'type' => 'int' , 'not null' => true , 'foreign key' => true , 'target' => 'Actor.id' , 'multiplicity' => 'one to many' , 'description' => 'the actor this language entry refers to' ],
'language_id' => [ 'type' => 'int' , 'not null' => true , 'foreign key' => true , 'target' => 'Language.id' , 'multiplicity' => 'many to many' , 'description' => 'the language this entry refers to' ],
2021-11-16 02:00:58 +09:00
'ordering' => [ 'type' => 'int' , 'not null' => true , 'description' => 'the order in which a user\'s language options should be displayed' ],
2021-10-28 09:26:16 +09:00
],
'primary key' => [ 'actor_id' , 'language_id' ],
'indexes' => [
'actor_idx' => [ 'actor_id' ],
],
];
}
}