Jet\DataModel_Definition_Property

Základní abstraktní třída, která je společná pro definici všech typů vlastností. Od této třídy dědí jednotlivé třídy reprezentující jednotlivé typy.

Přehled metod

Metoda Význam
public __construct(
string $data_model_class_name,
string $name,
?array $definition_data=null
)		 Parametry:
  • $data_model_class_name
    Název třídy do níž vlastnost náleží.
  • $name
    Název vlastnosti.
  • $definition_data
    Surová data definice načtená z atributů.
public setUp(
array $definition_data
) : void		 Nastaví definici pomocí surových dat načtených z atributů.
public setUpRelation(
string $related_to_class_name,
string $related_to_property_name
) : void		 Nastaví relaci - tedy nastaví, že daná vlastnost je vázána na jinou vlastnost (parametr $related_to_property_name) jiné třídy ($related_to_class_name).
public getDataModelClassName(
) : string		 Vrátí název třídy ke které vlastnost náleží.
public getType(
) : string		 Vrátí identifikaci typu vlastnosti. Tedy jedno z konstant DataModel::TYPE_*
public getName(
) : string		 Vrátí název vlastnosti.
public getDataModelDefinition(
) : DataModel_Definition_Model_Main|
DataModel_Definition_Model_Related		 Vrátí definici entity ke které vlastnost náleží.
public getRelatedToClassName(
) : null|string		 Vrátí název třídy, ke které je vlastnost v relaci.
public getRelatedToPropertyName(
) : string|null		 Vrátí název vlastnosti jiné třídy, ke které je vlastnost v relaci.
public getDatabaseColumnName(
) : string		 Vrátí definovaný, nebo vygenerovaný název sloupečku databázové tabulky.
public getIsKey(
) : bool		 Indikuje zda je vlastnost označena jako (jednoduchý) klíč - index.
public getIsUnique(
) : bool		 Indikuje zda je vlastnost označena jako (jednoduchý) unikátní klíč.
public getIsId(
) : bool		 Indikuje zda je daná vlastnost označena jako identifikační.
public doNotExport(
) : bool		 Indikuje zda je zakázané vlastnost exportovat do JSON (případně XML a jakéhokoliv dalšího exportu).
public getMustBeSerializedBeforeStore(
) : bool		 Indikuje zda hodnota vlastnosti daného typu musí být před uložení serializována.
public getCanBeTableField(
) : bool		 Indikuje zda vlastnost daného typu vůbec vytváří databázový sloupeček.
public getCanBeInSelectPartOfQuery(
) : bool		 Indikuje zda vlastnost daného typu může být použita v SELECT části dotazu.
public getCanBeInInsertRecord(
) : bool		 Indikuje zda hodnota vlastnosti daného typu může být reálně ukládána do databáze jako nový záznam.
public getCanBeInUpdateRecord(
) : bool		 Indikuje zda hodnota vlastnosti daného typu může být reálně ukládána do databáze jako aktualizace existujícího záznamu.
public getMaxLen(
) : int|null		 Pokud je pro daný typ relevantní maximální délka, tak ji vrací.
public getDefaultValue(
) : mixed		 Vrací výchozí hodnotu dané vlastnosti. Ta je určena deklarací samotné vlastnosti (tedy běžná deklarace vlastnosti třídy - ne definována v rámci atributů)
public checkValueType(
mixed& $value
) : void		 Ověří a případně přetypuje danou hodnotu na typ (z hlediska PHP) relevantní pro daný typ z hlediska DataModel.
public loadPropertyValue(
mixed& $property,
array $data
) : void		 Ze surových dat načtených z databáze backendem převezme hodnotu, ty přetypuje a přidělí vlastnosti instance dané entity.
public getJsonSerializeValue(
mixed& $property
) : mixed		 Vrátí hodnotu vlastnosti tak, aby byla serializovatelná do formátu JSON dle specifik daného typu.
public getAllRelatedPropertyDefinitions(
array& $related_definitions
) : void		 Interní metoda sloužící ke zjištění všech vnitřních relací.
public getBackendOptions(
string $backend_type
) : array		 Vrátí definované nastavení specifické pro daný typ backendu.
Předchozí kapitola
Jet\DataModel_Definition_Model_Related_1toN
Další kapitola
Jet\DataModel_Definition_Property_Bool
GitHub