diff --git a/application/cs/modules.texy b/application/cs/modules.texy index dd58b910d4..2d0c91817e 100644 --- a/application/cs/modules.texy +++ b/application/cs/modules.texy @@ -2,29 +2,49 @@ Moduly ****** .[perex] -Moduly představují v Nette logické celky, ze kterých se aplikace skládá. Jejich součástí jsou presentery, šablony, případně i komponenty a modelové třídy. +Moduly přinášejí do aplikací v Nette možnost členění do logických celků pro lepší přehlednost. -S jednou složkou pro presentery a jednou pro šablony bychom si u reálných projektů nevystačili. Mít v jedné složce desítky souborů je minimálně nepřehledné. Jak z toho ven? Jednoduše je na disku rozdělíme do podadresářů a v kódu do jmenných prostorů. A přesně to jsou v Nette moduly. -Zapomeňme tedy na jednu složku pro presentery a šablony a místo toho vytvoříme moduly, například `Admin` a `Front`. +Podobně jako si na disku třídíme soubory do jednotlivých adresářů, tak i v Nette si presentery, šablony a další pomocné třídy můžeme zařazovat do modulů. +Jak to vypadá v praxi? Jednoduše přidáme do adresářové struktury nové složky. Na tomto příkladu vytváříme dva moduly `Front` a `Admin`: /--pre app/ -├── Presenters/ -├── Modules/ ← adresář s moduly +├── UI/ │ ├── Admin/ ← modul Admin -│ │ ├── Presenters/ ← jeho presentery +│ │ ├── @layout.latte +│ │ ├── Dashboard/ │ │ │ ├── DashboardPresenter.php -│ │ │ └── templates/ -│ └── Front/ ← modul Front -│ └── Presenters/ ← jeho presentery -│ └── ... +│ │ │ └── default.latte +│ ├── Front/ ← modul Front +│ │ ├── Home/ +│ │ │ ├── HomePresenter.php +│ │ │ └── default.latte +│ │ └── ... +\-- + +xxx + +/--pre +app/ +├── UI/ +│ ├── Admin/ ← modul Admin +│ │ ├── @layout.latte +│ │ ├── Dashboard/ +│ │ │ ├── DashboardPresenter.php +│ │ │ └── default.latte +│ ├── Front/ ← modul Front +│ │ ├── Home/ +│ │ │ ├── HomePresenter.php +│ │ │ └── default.latte +│ │ └── ... \-- -Tuto adresářovou strukturu budou reflektovat jmenné prostory tříd, takže třeba `DashboardPresenter` bude v prostoru `App\Modules\Admin\Presenters`: + +Tuto adresářovou strukturu budou reflektovat jmenné prostory tříd, takže třeba `DashboardPresenter` bude v prostoru `App\UI\Admin`: ```php -namespace App\Modules\Admin\Presenters; +namespace App\UI\Admin\Dashboard; class DashboardPresenter extends Nette\Application\UI\Presenter { @@ -33,7 +53,7 @@ class DashboardPresenter extends Nette\Application\UI\Presenter ``` Na presenter `Dashboard` uvnitř modulu `Admin` se v rámci aplikace odkazujeme pomocí dvojtečkové notace jako na `Admin:Dashboard`, na jeho akci `default` potom jako na `Admin:Dashboard:default`. -A jak Nette vlastní ví, že `Admin:Dashboard` představuje třídu `App\Modules\Admin\Presenters\DashboardPresenter`? To mu řekneme pomocí [#mapování] v konfiguraci. +A jak Nette vlastní ví, že `Admin:Dashboard` představuje třídu `App\UI\Admin\Dashboard\DashboardPresenter`? To mu řekneme pomocí [#mapování] v konfiguraci. Tedy uvedená struktura není pevná a můžete si ji upravit podle potřeb. Moduly mohou kromě presenterů a šablon samozřejmě obsahovat všechny další součásti, jako jsou třeba komponenty, modelové třídy, atd. @@ -46,19 +66,19 @@ Moduly nemusí tvořit jen plochou strukturu, lze vytvářet i submoduly, např /--pre app/ -├── Modules/ ← adresář s moduly +├── UI/ ← presentery, šablony a pomocné třídy │ ├── Blog/ ← modul Blog │ │ ├── Admin/ ← submodul Admin -│ │ │ ├── Presenters/ +│ │ │ ├── Dashboard/ │ │ │ └── ... │ │ └── Front/ ← submodul Front -│ │ ├── Presenters/ +│ │ ├── Home/ │ │ └── ... │ ├── Forum/ ← modul Forum │ │ └── ... \-- -Tedy modul `Blog` je rozdělen do submodulů `Admin` a `Front`. A opět se to odrazí na jmenných prostorech, které budou `App\Modules\Blog\Admin\Presenters` apod. Na presenter `Dashboard` uvnitř submodulu se odkazujeme jako `Blog:Admin:Dashboard`. +Tedy modul `Blog` je rozdělen do submodulů `Admin` a `Front`. A opět se to odrazí na jmenných prostorech, které budou `App\UI\Blog\Admin\...` apod. Na presenter `Dashboard` uvnitř submodulu se odkazujeme jako `Blog:Admin:Dashboard`. Zanořování může pokračovat libovolně hluboko, lze tedy vytvářet sub-submoduly. @@ -104,11 +124,11 @@ Mapování Definuje pravidla, podle kterých se z názvu presenteru odvodí název třídy. Zapisujeme je v [konfiguraci|configuration] pod klíčem `application › mapping`. -Začněme ukázkou, která moduly nepoužívá. Budeme jen chtít, aby třídy presenterů měly jmenný prostor `App\Presenters`. Tedy aby se presenter například `Home` mapoval na třídu `App\Presenters\HomePresenter`. Toho lze docílit následující konfigurací: +Začněme ukázkou, která moduly nepoužívá. Budeme jen chtít, aby třídy presenterů měly jmenný prostor `App\UI`. Tedy aby se presenter například `Home` mapoval na třídu `App\UI\HomePresenter`. Toho lze docílit následující konfigurací: ```neon application: - mapping: App\Presenters\*Presenter + mapping: App\UI\*Presenter ``` Název presenteru se nahradí za hvezdičku v masce třídy a výsledkem je název třídy. Snadné! @@ -118,30 +138,30 @@ Pokud presentery členíme do modulů, můžeme pro každý modul mít vlastní ```neon application: mapping: - Front: App\Modules\Front\Presenters\*Presenter - Admin: App\Modules\Admin\Presenters\*Presenter + Front: App\UI\Front\*Presenter + Admin: App\UI\Admin\*Presenter Api: App\Api\*Presenter ``` -Nyní se presenter `Front:Home` mapuje na třídu `App\Modules\Front\Presenters\HomePresenter` a presenter `Admin:Dashboard` na třídu `App\Modules\Admin\Presenters\DashboardPresenter`. +Nyní se presenter `Front:Home` mapuje na třídu `App\UI\Front\HomePresenter` a presenter `Admin:Dashboard` na třídu `App\UI\Admin\DashboardPresenter`. Praktičtější bude vytvořit obecné (hvězdičkové) pravidlo, které první dvě nahradí. V masce třídy přibude hvezdička navíc právě pro modul: ```neon application: mapping: - *: App\Modules\*\Presenters\*Presenter + *: App\UI\*\*Presenter Api: App\Api\*Presenter ``` -Ale co když používáme vícenásobně zanořené moduly a máme třeba presenter `Admin:User:Edit`? V takovém případě se segment s hvězdičkou představující modul pro každou úroveň jednoduše zopakuje a výsledkem bude třída `App\Modules\Admin\User\Presenters\EditPresenter`. +Ale co když používáme vícenásobně zanořené moduly a máme třeba presenter `Admin:User:Edit`? V takovém případě se segment s hvězdičkou představující modul pro každou úroveň jednoduše zopakuje a výsledkem bude třída `App\UI\Admin\User\EditPresenter`. Alternativním zápisem je místo řetězce použít pole skládající se ze tří segmentů. Tento zápis je ekvivaletní s předchozím: ```neon application: mapping: - *: [App\Modules, *, Presenters\*Presenter] + *: [App\UI, *, *Presenter] ``` Výchozí hodnotou je `*Module\*Presenter`.