1	<?php
2
3	/**
4	* This program is free software; you can redistribute it and/or
5	* modify it under the terms of the GNU General Public License
6	* as published by the Free Software Foundation; under version 2
7	* of the License (non-upgradable).
8	*
9	* This program is distributed in the hope that it will be useful,
10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12	* GNU General Public License for more details.
13	*
14	* You should have received a copy of the GNU General Public License
15	* along with this program; if not, write to the Free Software
16	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17	*
18	* Copyright (c) 2018 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
19	*
20	*/
21
22	namespace oat\oatbox\user;
23
24	/**
25	* Interface UserLanguageServiceInterface
26	* @package oat\oatbox\user
27	*/
28	interface UserLanguageServiceInterface
29	{
30	public const SERVICE_ID = 'generis/UserLanguageService';
31
32	/**
33	* @return string language code (e.g. 'en-US')
34	*/
35	public function getDefaultLanguage();
36
37	/**
38	* @param User $user
39	* @return string language code (e.g. 'en-US')
40	*/
41	public function getDataLanguage(User $user);
42
43	/**
44	* @param User $user
45	* @return string language code (e.g. 'en-US')
46	*/
47	public function getInterfaceLanguage(User $user);
48
49	/**
50	* Whether users data language enabled or not
51	* @return boolean
52	*/
53	public function isDataLanguageEnabled();
54
55	/**
56	* When a custom interface language is set, it overrides the interface language retrieved in the
57	* getInterfaceLanguage method.
58	*
59	* @param ?string $customInterfaceLanguage
60	*/
61	public function setCustomInterfaceLanguage(?string $customInterfaceLanguage): void;
62	}