[2009–09–25] Adresářová struktura a moduly

Nová doporučená adresářová struktura – hezké :) Ale dělá mi starost ta složka models – co když chci jednu třídu využívat ve více modulech? Např. UserModel – ve WebModule slouží např. k registraci uživatelů a v AdminModule k jejich editaci a mazání. Nechtěl bych pro to dělat dvě třídy.

Mimochodem, jak řešíte šablony pro komponenty? Klasika je asi dávat je do /controls/Name/, zkrátka k PHP třídě dané komponenty, ale co kdybych to chtěl mít oddělené? Např. pro to, kdybych měl na hostingu jednu centrální složku pro všechny Nette komponenty, které by využívalo více webů, ale každý by samozřejmě potřeboval vlastní šablonu?

OK :) Co lze teď použít namísto templatesDir? Myslel jsem, že tak teď začne fungovat appDir, ale ta mi vede stále pouze do /app/ a ne do /app/WebModule. Potřebuju pro pro určení cesty WebLoaderu.

LastHunter napsal(a):

OK :) Co lze teď použít namísto templatesDir? Myslel jsem, že tak teď začne fungovat appDir, ale ta mi vede stále pouze do /app/ a ne do /app/WebModule. Potřebuju pro pro určení cesty WebLoaderu.

Můžeš si ty proměnné nastavit v configu ostatně jako píše David v úvodním příspěvku.

Osobně používám následující způsob (momentálně je napsaný pro staré rozmístění modulů, fungovat ale bude nezávisle na adresářové struktuře):

Pro každý modul mám třídu, která dědí od abstraktní třídy BaseModule:

<?php
abstract class BaseModule extends Object
{
	public function setupRouter(IRouter $router) { }
	public function setupPermission(SitePermission $permission) { }
	public function setupHooks(SiteHooks $hooks) { }
	// ...
}
?>

V dané třídě překryji požadované metody:

<?php
class PageModule extends BaseModule
{
	public function setupRouter(IRouter $router)
	{
		$router[] = new PageRoute('<uri>', array(
			'presenter' => 'Page',
			'action' => 'default'
		));
	}

	public function setupPermission(SitePermission $permission)
	{
		$permission->addResource('Page');
		$permission->addPrivilege('Page', array('edit', 'create'));
	}

	public function setupHooks(SiteHooks $hooks)
	{
		$hooks->add('Blocks', 'PageModule::blocksEntry');
		$hooks->add('Dashboard/Blocks', 'PageModule::dashboardEntry');
		$hooks->add('AdminMenu', 'PageModule::setupAdminMenu');
	}

	// ...
}
?>

V config.ini mám seznam modulů, které si přeji načíst:

[common]
modules[] = Admin
modules[] = Page
modules[] = News
modules[] = Gallery
modules[] = Article
modules[] = Document

Třída SiteApplication (potomek Application, je nastavený v config.ini jako service pro Nette\Application\Application) mi vše načte a spustí ve správný čas:

<?php
class SiteApplication extends Application
{
	protected $modules;

	/**
	 * @var Cache
	 */
	protected $cache;

	protected $hooks;


	public function run()
	{
		$this->cache = Environment::getCache('Application');

		$modules = Environment::getConfig('modules');
		foreach ($modules as $module)
			$this->loadModule($module);

		$this->setupRouter();
		$this->setupHooks();

		// Requires database connection
		$this->onRequest[] = array($this, 'setupPermission');

		// ...

		// Run the application!
		parent::run();

		$this->cache->release();
	}

	protected function loadModule($module)
	{
		$class = $module . 'Module';
		$this->modules[$module] = new $class;
	}

	protected function setupRouter()
	{
		if (Environment::isProduction() && isset($this->cache['router'])) {
			$this->setRouter($this->cache['router']);
		} else {
			SiteRoute::initialize();

			$router = $this->getRouter();
			// Homepage
			$router[] = new SiteRoute('<? (index\.(php|html?))?>', array(
				'presenter' => 'Homepage',
				'action' => 'default',
			), Route::ONE_WAY);

			// Modules routes
			foreach ($this->modules as $module)
				$module->setupRouter($router);

			// Default route
			$router[] = new SiteRoute('<presenter>/<action>/<id>', array(
				'presenter' => 'Homepage',
				'action' => 'default',
				'id' => NULL,
			));

			$this->cache->save('router', $router);
		}
	}

	public function setupPermission()
	{
		// ...
	}

	protected function setupHooks()
	{
		if (Environment::isProduction() && isset($this->cache['hooks'])) {
			$this->hooks = $this->cache['hooks'];
		} else {
			$this->hooks = new SiteHooks();

			foreach ($this->modules as $module)
				$module->setupHooks($this->hooks);

			$this->cache->save('hooks', $this->hooks);
		}
	}

	// ...
}
?>

Celá moje aplikace je napsaná tak, aby podporovala několik propojených webů běžících na jediné instalaci, takže možnost definovat moduly v rámci sekce config.ini je pro mě klíčová.

Jak ale zde řešit když mám několik modulů a jednu administraci jak udělat aby byl jeden globální @layout.phtml pro admina.
Struktura je

CoreModule
 	- AdminModule
		- presenters
		- templates
			- @layout.phtml << ten layout globálně pro admina
	- FrontModule
		- presenters, templates
PageModule
 	- AdminModule
		- presenters
		- templates (zde bez @layout.phtml a nebo dědit @layout.phtml v CoreModule)
	- FrontModule
		- presenters, templates

doufám že to někdo pochopil, diky

To co jsi napsal mě napadlo hned (to jsem ještě nepsal příspěvek) ale otázka jde to zglobalizovat jestli že se jmenuje stejně modul ( = AdminModule) ? Tak jo udělám v AdminBasePresenteru funkci formatLayoutTemplateFiles a hotovo :D

Jeste dodam ze problem je tato vyjimka:

Cannot load presenter ‚Error‘, class ‚ErrorPresenter‘ was not found in ‚/home/simon/Workspace/php/nette/project/baskytara_com/html/../app/presenters/ErrorPresenter.php‘.

Na tom umisteni samozrejme presenter neni. Nevim tedy jak nette donutit aby presenter hledalo v adresari s modulem.

V souvislosti s adresářovou strukturou obecně bych se chtěl zeptat, kam byste umístili následující:

1. V adresáři libs mám knihovnu Texy. Vytvořil jsem si poděděnou třídu, ve které mám handler pro zvýranění syntaxe pomocí FSHL. Ten rovnou registruji do Texy:

class TexyFshl extends Texy

Vím, že toto by asi šlo přidat třeba do BasePresenteru, ale není nějaké lepší řešení, kam to umístit?

2. Funkce getId a getPath, které používám jako masku pro routování. Kam je dát?

Nehodilo by se mít pro tyto případy v app/ ještě nějakou další složku?

Editoval Juan (29. 9. 2009 14:41)

To záleží čistě na tobě.

Třeba si vytvoř novou složku v app/ nebo do libs/. Nette tě nijak neomezuje.

Díky, přesně tak to používám. Jen mi šlo o to, jestli je to ona „Best Practise“…

na1k napsal(a):

Po nějaké době jsem updatoval na novou dev revizi a s tím jsem i přeorganizoval adresáře podle prvního Davidova postu. Jenže se mi něco pokazilo, protože se mi namísto celé stránky vykreslí jen šablona aktuálního view. Chybí tedy celý @layout.
Netušíte někdo co je špatně? soubor s layoutem mám v app\FrontModule\templates\@layout.phtml

Nový systém počítá s tím, že používáš „nové šablony“ – s makry {block} a {extends}. Doporučuji shlédnout přednášku: http://blip.tv/file/2514636

Šmankote, jak tak koukám na Pandův příklad komplexní aplikace, zjišťuju že se mám eště dst co učit :D

Ale chtělo by to nějaký howto na komplexitu, tohle bych vymejšlel dlouho. Taky by mě zajímalo třeba když máš třídu *Module jak to zapasuješ do MVP? Nebo jsou moduly (*Module, ne adresář) jen na router/permissions…?

Nazdar,
moje hooks jsou tak trochu inspirovány hooky v Drupalu (principem, ne realizací – Drupal není psán objektově). Tam slouží k tomu, aby modul mohl ovlivnit všechno možné, od nových typů obsahu, přes existující formuláře až po různá interní zpracování vložených dat a tak podobně.

Tak daleko, jako jde Drupal, jsem ale nešel. Moje hooky používám na občasné ovlivnění určitých prvků webu, například jako hlavní stránku administrační sekce mám nástěnku. Ta je bez modulů prázdná, naplní se právě až pomocí těch modulů – modul si zaregistruje na hook funkci (používám statické funkce, abych mohl jednoduše cachovat, ačkoliv to není z hlediska objektového návrhu úplně ideální), té funkci se předá objekt (Hashtable) s aktuálním seznamem bloků a jen do tohoto objektu přidá záznam. Pak až je potřeba sestavit seznam těchto bloků, tak se jen projde pole takto zaregistrovaných funkcí, zavolají se a seznam bloků na nástěnce je na světě.

Další použití, které je v kódu vidět, je sestavování administračního menu. Zaregistrovaná funkce opět přidává do objektu záznam, popř. sadu záznamů. Další využití, které v kódu vidět není a které ještě nemám napsané, by byl modul komentářů. Tam by se registroval hook, který by modifikoval formulář na přidávání článku/novinky/galerie – přidal by do něj možnost výběru, zda je možno přidávat komentáře nebo ne.

Stejně dobře bych si mohl nadefinovat nějakou prázdnou funkci v předkovi všech modulů a pak jí jen podle potřeby přepsat, ale s rostoucím počet hooků by se celá třída stávala dosti velká a při větším množství modulů by se celkem zbytečně volala kopa funkcí, které nic nedělají. Obecně jsem se pak řídil pravidlem, že co bude pravděpodobně ovlivňovat každý modul (např. oprávnění, sitemapa, routy…), jsem realizoval pomocí prázdné funkce v předkovi, ale to, co bude využívat menší množství modulů, jsem vyřešil pomocí hooků.

app/application/SiteApplication.php, přepisuji i některé další třídy, které s aplikací souvisí, takže v té složce těch souborů mám víc.

enoice: Mno já si zrovna myslím, že do dotaženosti má mé řešení ještě daleko… Ale je fakt, že kdybych něco publikoval, tak by se to možná dalo společnými silami nějak dotáhnout. Něco tedy sepíšu, ale až časem. Možná bych se mohl zaměřit i na další věci, např. jednoduchá cesta k vlastním routám, ještě šikovnější Permission a tak.

Adresářová struktura je super, ale fakt dlouho jsem se propracovával ke všem informacím, které jsem potřeboval. Chápu, že dodělat dokumentaci je hodně práce, ale možná by nebylo na škodu udělat skeleton2 s rozdělením aplikace do modulů, aby tam byl {plink} mezi modulama.

Moje chyba, teď jsem si všiml, že to je v examples :)

Editoval vyvazil.jakub (3. 12. 2009 12:52)

Vyki napsal(a):

Aby toto šlo udělat tak jsem si vytvořil a jako službu service.Nette-Application-IPresenterLoader zaregistroval vlastní (podědil a upravil metodu formatPresenterFile) PresenterLoader, tak aby mi to akceptovalo novou adr. strukturu.

Vždyť to není potřeba. RobotLoader umí načíst presentery odkudkoliv. Úkolem IPresenterLoaderu je jen zjistit jméno třídy.

články v dokumentaci wordpressu jsou imho docela k ničemu, protože tam se používá procedurální přístup a já osobně jsem to ani pořádně nepochopil :)

Zatiaľ, kým máme vo frameworku Environment to pôjde takto:

Environment::setVariable('templatesDir', '/cesta/z/mesta');

Editoval kravčo (7. 10. 2010 0:07)

Aha, ty potrebuješ meniť adresár, z ktorého sa načítavajú templejty… Nette interne premenné ako templatesDir vôbec nepoužíva už vyše roka (od 6b45a1f), no neviem či je táto zmena aj v 0.9.x

Čiže naozaj ti asi nezostáva iné ako prepísať formatTemplateFiles().