Maslosoft Mangan API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 <?php
/**
* This software package is licensed under AGPL or Commercial license.
*
* @package maslosoft/mangan
* @licence AGPL or Commercial
* @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com>
* @copyright Copyright (c) Maslosoft
* @copyright Copyright (c) Others as mentioned in code
* @link https://maslosoft.com/mangan/
*/
namespace Maslosoft\Mangan\Interfaces;
/**
* Implement this interface on your model to anable I18N fields support
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
interface InternationalInterface
{
const EventBeforeLanguagesSet = 'beforeLanguagesSet';
const EventAfterLanguagesSet = 'afterLanguagesSet';
const EventBeforeLangChange = 'beforeLangChange';
const EventAfterLangChange = 'afterLangChange';
/**
* Get language code
* @return string Language code
*/
public function getLang();
/**
* Set language code
* @param string $code
*/
public function setLang($code);
/**
* Get i18n values with all languages.
* This method must return value set by `setRawI18N`
* @return mixed[] Associative array of language values
*/
public function getRawI18N();
/**
* Set i18n values in all languages.
* This method must keep `$values` for further use, by method `getRawI18N`.
* @param mixed[] $values
*/
public function setRawI18N($values);
/**
* This method must return available language codes
* @return string[] Array of language codes
*/
public function getLanguages();
/**
* Set all available language codes
* @param string[] $languages
*/
public function setLanguages($languages);
/**
* Get default language code
*/
public function getDefaultLanguage();
/**
* Set default language code
* @param string $code
*/
public function setDefaultLanguage($code);
}
API documentation generated by ApiGen