Jet\MVC_Base_LocalizedData

Co je to báze a jak funguje jsme si vysvětlili zde a zde. V tabulce najdete přehled metod třídy Jet\MVC_Base_LocalizedData a také rozhraní Jet\MVC_Base_LocalizedData_Interface (třída je instancována zásadně pomocí továrny).

Základní parametry lokalizace

Metoda Význam
public getBase(
): MVC_Base_Interface;		 Vrátí istanci báze do které lokalizace náleží. Tedy de facto rodičovské entity.
public setBase(
MVC_Base_Interface $base
): void;		 Nastaví bázi do které lokalizace náleží.
public getLocale(
): Locale;		 Vrátí identifikaci lokalizace dat.
public setLocale(
Locale $locale
): void;		 Nastaví identifikaci lokalizace dat.
public getIsActive(
): bool;		 Indikuje zda je / není daná lokalizace báze aktivní.
public setIsActive(
bool $is_active
): void;		 Aktivuje / deaktivuje danou lokalizaci báze.
public getTitle(
): string;		 Vrátí výchozí titulek dané lokalizace báze. Titulek je možné použít ve výstupu pro koncové uživatele. Respektive přesněji se přímo počítá s využitím této hodnoty například pro
public setTitle(
string $title
): void;		 Nastaví výchozí titulek dané lokalizace báze.
public getURLs(
): array;		 Vrátí seznam všech URL dané lokalizace. URL obsahuje doménu a cestu. Ne však schéma/prefix. https://, nebo http://. URL musí vždy končit lokítkem (znakem '/')
Například: [
'domain/en/',
'en.domain/',
]
public setURLs(
array $URLs
): void;		 Nastaví seznam všech URL dané lokalizace. URL obsahuje doménu a cestu. Ne však schéma/prefix. https://, nebo http://. URL musí vždy končit lokítkem (znakem '/')

První URL v seznamu bude brána jako výchozí. Všechny ostantí URL jsou také platné, ale budou přesměrovány na výchozí URL.

Například: [
'domain/en/',
'en.domain/',
]
public getDefaultURL(
): string;		 Vrátí výchozí URL.
public getSSLRequired(
): bool;		 Indikuje zda daná lokalizace vyžaduje / nevyžaduje https spojení.
public setSSLRequired(
bool $SSL_required
): void;		 Nastavuje zda daná lokalizace vyžaduje / nevyžaduje https spojení.
public toArray(
): array;		 Vrátí data definice lokalizovaných dat báze v podobě asociovaného pole. Používá se pro ukládání definice.

Meta tagy

Někdy můžete potřebovat definovat výchozí meta tagy, které budou následně platné pro všechny stránky v dané lokalizaci (pokud je nějaká ze stránek nepřepíše vlastní hodnotou).

Metoda Význam
public getDefaultMetaTags(
): MVC_Base_LocalizedData_MetaTag_Interface[];		 Vrátí pole výchozích meta tagů dané lokalizace.
public addDefaultMetaTag(
MVC_Base_LocalizedData_MetaTag_Interface $default_meta_tag
): void;		 Přidá výchozí meta tag do dané lokalizace.
public removeDefaultMetaTag(
int $index
): void;		 Odebere meta tag na dané pozici. ($index = 0 znamená první v seznamu a tak dále)
public setDefaultMetaTags(
MVC_Base_LocalizedData_MetaTag_Interface[] $default_meta_tags
): void;		 Hromadně nastaví nové výchozí meta tagy. Staré nastavení zcela odstraní a nahradí novým.

Interní parametry

Jde o vámi libovolně volitelné parametry a jejich hodnoty. Vše využitelné vaší aplikací.

Použití? Tak si představte, že děláte e-shop. Pravděpodobně budete potřebovat definovat kód (nebo kódy) měny vázaný na danou lokalizaci. Nebo například nastavení zaokrouhlovaní a tak dále. Zkrátka jakoukoliv hodnotu, kterou potřebujete měnit dle aktuální báze a její lokalizace.

Metoda Význam
public getParameters(
): array		 Vrátí seznam interních parametrů v podobně asociovaného pole, kde klíč je název parametru.
public setParameters(
array $parameters
): void		 Hromadně nastaví parametry dané lokalizaci dané báze. Parametry jsou opět v podobě asociovaného pole.
public setParameter( 
string $key, 
mixed $value 
): void		 Nastaví jeden parametr.
public getParameter(
string $key,
mixed $default_value = null
): mixed		 Vrátí hodnotu specifikovaného parametru. Pokud daný parametr neexistuje, pak vrátí výchozí hodnotu.
public parameterExists(
string $key
): bool		 Zjišťuje zda parametr existuje.
Předchozí kapitola
Jet\MVC_Base
Další kapitola
Jet\MVC_Base_LocalizedData_MetaTag
GitHub