Jet\Form_Definition_Field

Třída představuje definici formulářového pole v rámci mapování formuláře na třídu.

Přehled metod

Metoda Význam
public __construct(
object $context_object,
string $property_name,
mixed& $property,
array $definition_data
)		 Parametry:
  • $context_object
    Instance objektu na nějž bude formulář napojen.
  • $property_name
    Název vlastnosti na kterou bude formulářové pole napojeno (=budoucí jméno formulářového pole).
  • &$property
    Reference na vlastnost na kterou bude formulářové pole napojeno.
  • $definition_data
    Definiční parametry v surové podobě.
public getContextObject(
) : object		 Vrací instanci objektu na nějž bude formulář namapován.
public getPropertyName(
) : string		 Název vlastnosti na kterou bude formulářové pole napojeno.
public getFieldName(
) : string		 Vrací název formulářového pole.
public getType(
) : string|bool		 Vrací typ formulářového pole (kód typu, ne název třídy formulářového pole)
public setType(
string|bool $type
) : void		 Nastavuje typ formulářového pole (kód typu, ne název třídy formulářového pole)
public getCreator(
) : ?callable		 Vrací případný vytvářeč.
public setCreator(
null|callable|array $creator
) : void		 Nastavuje vytvářeč.
public getDefaultValueGetterName(
) : string		 Vrací název metody určené k získání výchozí hodnoty formulářového pole.
public getSetterName(
bool $get_defined=false
) : string		 Vrací název setter metody pro nastavení zachycené hodnoty napojenému objektu.
public setSetterName(
string $setter_name
) : void		 Nastavuje název setter metody pro nastavení zachycené hodnoty napojenému objektu.
public getIsRequired(
) : bool		 Indukuje zda pole bude / nebude označeno jako povinné.
public getLabel(
) : string		 Vrací popisek pole.
public setLabel(
string $label
) : void		 Nastavuje popisek pole.
public getHelpText(
) : string		 Vrací text nápovědy pole.
public setHelpText(
string $help_text
) : void		 Nastavuje text nápovědy pole.
public getHelpData(
) : array		 Vrací data nápovědy formulářového pole.
public setHelpData(
array $help_data
) : void		 Nastavuje data nápovědy formulářového pole.
public getErrorMessages(
) : array		 Vrací chybová hlášení formulářového pole.
public setErrorMessages(
array $messages
) : void		 Nastavuje chybová hlášení formulářového pole.
public getOtherOption(
string $option,
mixed $default_value=''
) : mixed		 Vrací hodnotu parametru, který není součástí standardní definice (je vázán na konkrétní typ pole).
public createFormField(
array& $form_fields
) : void		 Dle definice vytvoří formulářové pole (nebo více polí) a ty předá do seznamu, který je předáván referencí jako parametr.
Předchozí kapitola
Jet\Form_Definition_Trait
Další kapitola
Jet\Form_Definition_SubForm
GitHub