KT CRUD Admin List

V případě, že využíváme vlastní tabulky pro ukládání dat v kombinaci s KT CRUD komponentou, pravděpodobně se nevyhneme tomu, abychom potřebovali z těchto záznamů sestavit nějaký přehled – výpis – pro uživatele. K tomuto nám poslouží tato komponenta, která se o celý výpis stará.

Logika práce s objektem

  1. Komponenta udržuje kolekci instancí komponenty KT CRUD Admin Column. Ta prezentuje vždy určitý typ a obsah daného sloupce.
  2. Admin list je vždy napojen na vlastní stránku, která se definuje pomocí komponenty KT Admin Screen.

Inicializace modelu

Pro správné použití je potřeba mít vlastní KT CRUD Model, který jsme si definovali, a je napojený na vlastní tabulku v naší databázi. Pro náš příklad budeme využívat KT Catalog Model Base, který je obecně popisován v dokumentaci jako základní kostra.

KT_FW_Catalog_Model je pomyslný model, který není automaticky dostupný. Je nutné si definovat vlastní model vycházející z KT CRUD nebo KT Catalog Model Base.

__construct($className, $tableName)

  • $className – název třídy, který reprezentuje KT CRUD Model, a je napojený na nějakou existující tabulku v DB.
  • $tableName – název tabulky v databázi, která je pro náš model určena.

Sada Getterů

getClassName()

Vrátí název PHP Classy (modelu), který byl použit v contructoru.

 getRepository()

Vrátí objekt KT Repository, který je určen pro jednoduchou a základní selekci dat z vlastní tabulky v databázi vycházející z KT CRUD.

getTemplateTitle()

Vrátí název – titulek – pro stránku, který se má zobrazit v případě, že je na stránce zobrazen právě daný crudList.

Sada Setterů

setColumnList(array $columnList)

Nastaví kolekci objektů KT CRUD Column List, která definuje každý sloupec zvlášť. Obecně se samotný setter často nepoužívá.

setNewItemButton($newItemButton = true)

Nastaví, zda se má vykreslit „tlačítko“ s odkazem na možnost přidání nového záznamu do tabulky. Tuto funkci je nutné kombinovat správně s nastavením vlastní stránky a samotným datovým modelem.

setTemplateTitle($templateTitle)

Nastaví titulek, který bude použit jako nadpis na vlastní stránce v případě, že stránka bude vykreslovat právě tento crudList.

setSortable($sortable = true)

Nastaví, zda má mít uživatel možnost řadit záznamy pomocí přetažení řádků na jinou pozici.

Tato funkce je úzce spojená s KT Catalog Model Base a sloupcem menu_order.

Obecné funkce komponenty

addColumn($name)

Založí a přidá do kolekce sloupců jeden sloupec (KT CRUD Admin Column).

addColumnsToCollection(array $columnCollection)

Přidá do kolekce sloupců další sloupce. Provede tedy merge obou kolekcí, nikoli pouze set proměnné.

removeColumnFromCollection ($columnName)

Z kolekce sloupců odstraní jeden sloupec dle jeho názvu.

getColumnByName($columnName)

Vrátí z kolekce sloupec s příslušným názvem.

getContent()

Vrátí HTML obsah celého listu pro jeho vykreslení. Obecně není potřeba funkci používat. Funkce je používána interně v rámci objektu. Je veřejná pro případ, že by bylo potřeba crudList vypisovat na jiném layoutu.

isSortable()

Funkce vrátí true nebo false dle nastavení sortable módu.

Příklad použití komponenty

Založení vlastní stránky

V první řadě potřebujeme vlastní stránku, do které náš crudList umístíme.

Definice crudListu

Nyní budeme potřebovat vydefinovat náš list sloupců a záznamů, které do samotné stránky přidáme.

Finální vykreslení a napojení na potřebné akce

Nyní už potřebujeme pouze námi definovaný crudList napojit do naší vlastní stránky a nastavit potřebné akce.

 

 



Odebírejte novinky z FW

Sledujte nás!

Tyto stránky využívají Cookies. Používáním těchto stránek vyjadřujete souhlas s používáním Cookies.Zjistit víceOK, rozumím