====== LanguageService ======
**Layer:** ''Service'' · **Source:** ''lib/service/LanguageService.php:21'' (lines 21–154)
----
class LanguageService
======= Docblock Metadata =======
^ Tag ^ Value ^
| ''@category'' | service class |
| ''@author'' | M.Noermoehammad |
| ''@license'' | MIT |
| ''@version'' | 1.0 |
| ''@since'' | Since Release 1.0 |
======= Inheritance =======
//No parent, interface or trait. This is a root type.//
======= Constants (0) =======
//None.//
======= Properties (2) =======
^ Visibility ^ Type ^ Name ^ Default ^ Line ^
| ''private'' | ''(untyped)'' | ''$languageDao'' | | 23 |
| ''private'' | ''(untyped)'' | ''$translationDao'' | | 24 |
======= Methods (12) =======
^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | (undocumented) | 26 |
| public | ''createLanguage()'' | (undocumented) | 32 |
| public | ''updateLanguage()'' | (undocumented) | 56 |
| public | ''deleteLanguage()'' | (undocumented) | 77 |
| public | ''setDefaultLanguage()'' | (undocumented) | 91 |
| public | ''getActiveLanguages()'' | (undocumented) | 105 |
| public | ''getAllLanguages()'' | (undocumented) | 110 |
| public | ''getDefaultLanguage()'' | (undocumented) | 115 |
| public | ''getLanguageByCode()'' | (undocumented) | 120 |
| public | ''getLanguageById()'' | (undocumented) | 125 |
| public | ''getLanguageCodes()'' | (undocumented) | 130 |
| private | ''validateLanguageData()'' | (undocumented) | 136 |
======== __construct() ========
public function __construct()
//lines 26–30 (5)//
//Takes no parameters.//
======== createLanguage() ========
public function createLanguage(array $data): int
//lines 32–54 (23)//
^ Parameter ^ Type ^ Default ^ Description ^
| ''$data'' | ''array'' | //required// | //none// |
**Returns:** ''int''
======== updateLanguage() ========
public function updateLanguage(int $id, array $data): void
//lines 56–75 (20)//
^ Parameter ^ Type ^ Default ^ Description ^
| ''$id'' | ''int'' | //required// | //none// |
| ''$data'' | ''array'' | //required// | //none// |
**Returns:** ''void''
======== deleteLanguage() ========
public function deleteLanguage(int $id): void
//lines 77–89 (13)//
^ Parameter ^ Type ^ Default ^ Description ^
| ''$id'' | ''int'' | //required// | //none// |
**Returns:** ''void''
======== setDefaultLanguage() ========
public function setDefaultLanguage(int $id): void
//lines 91–103 (13)//
^ Parameter ^ Type ^ Default ^ Description ^
| ''$id'' | ''int'' | //required// | //none// |
**Returns:** ''void''
======== getActiveLanguages() ========
public function getActiveLanguages(): array
//lines 105–108 (4)//
//Takes no parameters.//
**Returns:** ''array''
======== getAllLanguages() ========
public function getAllLanguages(): array
//lines 110–113 (4)//
//Takes no parameters.//
**Returns:** ''array''
======== getDefaultLanguage() ========
public function getDefaultLanguage(): ?array
//lines 115–118 (4)//
//Takes no parameters.//
**Returns:** ''?array''
======== getLanguageByCode() ========
public function getLanguageByCode(string $code): ?array
//lines 120–123 (4)//
^ Parameter ^ Type ^ Default ^ Description ^
| ''$code'' | ''string'' | //required// | //none// |
**Returns:** ''?array''
======== getLanguageById() ========
public function getLanguageById(int $id): ?array
//lines 125–128 (4)//
^ Parameter ^ Type ^ Default ^ Description ^
| ''$id'' | ''int'' | //required// | //none// |
**Returns:** ''?array''
======== getLanguageCodes() ========
public function getLanguageCodes(): array
//lines 130–134 (5)//
//Takes no parameters.//
**Returns:** ''array''
======== validateLanguageData() ========
private function validateLanguageData(array $data): void
//lines 136–153 (18)//
^ Parameter ^ Type ^ Default ^ Description ^
| ''$data'' | ''array'' | //required// | //none// |
**Returns:** ''void''
======= Imports =======
^ Alias ^ Fully-qualified name ^
| ''ServiceException'' | [[scriptlog:lib:core:serviceexception|''Scriptlog\Core\ServiceException'']] |
| ''LanguageDao'' | [[scriptlog:lib:dao:languagedao|''Scriptlog\Dao\LanguageDao'']] |
| ''TranslationDao'' | [[scriptlog:lib:dao:translationdao|''Scriptlog\Dao\TranslationDao'']] |
----
//This page is generated from source by 'tools/gendoc'. Edits will be overwritten.//