Jet\Config_Definition_Property

Základní třída pro definici vlastností / konfiguračních hodnot. Abstraktní třída od které dědí ostatní třídy představující již konkrétní typy.

Metoda Význam
public __construct(
string|Config $configuration_class_name,
string $name,
?array $definition_data = null
)		 Parametry:
  • $configuration_class_name
    Jméno konfigurační třídy do které vlastnost / konfigurační hodnota náleží
  • $name
    Název vlastnosti / konfigurační hodnoty
  • $definition_data
    Definiční data získaná z atributů.
public setUp(
?array $definition_data = null
): void		 Nastaví definici dle definičních dat. Interní metoda.
public getName(
): string		 Vrátí název vlastnosti / konfigurační hodnoty.
public getIsRequired(
): bool		 Indikuje zda je / není vlastnost / konfigurační hodnota vyžadována.
public setIsRequired(
bool $is_required
): void		 Nastaví zda je / není vlastnost / konfigurační hodnota vyžadována.
public getType(
): string		 Vrátí typ vlastnosti / konfigurační hodnoty.
public prepareValue(
mixed $value,
Config $config
): mixed		 Připraví konfigurační hodnotu. Konkrétně to znamená že ověří typ hodnoty a hodnotu validuje (pokud je to nutné).
abstract protected checkValueType(
mixed &$value
): void		 Ověření typu hodnoty. Tuto abstraktní metodu musí implementovat třídy reprezentující jednotlivé typy.
abstract protected checkValue(
mixed $value
): void		 Validuje hodnotu. Tuto abstraktní metodu musí implementovat třídy reprezentující jednotlivé typy.
public __toString(
): string
public toString(
): string 		Pro účely ladění je možné definici převést na řetězec. Vrátí: Some\Class::property_name.
Předchozí kapitola
Jet\Config_Definition_Config_Section
Další kapitola
Jet\Config_Definition_Property_String
GitHub