WebToDate/Příručka vývojáře/Úlohy pro Plánovač úloh - Historie editací

Jardac: Nahrazení textu „[[Category:WebToDate 4.1“ textem „[[Category:WebToDate“

2009-10-13T12:42:35Z

Nahrazení textu „[[Category:WebToDate 4.1“ textem „[[Category:WebToDate“

← Starší verze		Verze z 13. 10. 2009, 14:42
Řádek 1:		Řádek 1:
	[[Category:WebToDate ~~4.1~~ Příručka vývojáře]]		[[Category:WebToDate Příručka vývojáře]]
	[[Category:Příručka vývojáře]]		[[Category:Příručka vývojáře]]
	== Úvod ==		== Úvod ==

Jardac: Stránka WebToDate 4.1/Příručka vývojáře/Úlohy pro Plánovač úloh přemístěna na stránku WebToDate/Příručka vývojáře/Úlohy pro Plánovač úloh

2009-10-13T12:39:03Z

Stránka WebToDate 4.1/Příručka vývojáře/Úlohy pro Plánovač úloh přemístěna na stránku WebToDate/Příručka vývojáře/Úlohy pro Plánovač úloh

← Starší verze	Verze z 13. 10. 2009, 14:39
(Žádný rozdíl)

Bajkvl: /* */

2009-09-24T08:44:30Z

← Starší verze		Verze z 24. 9. 2009, 10:44
Řádek 322:		Řádek 322:

	==== Metody a vlastnosti ====		==== Metody a vlastnosti ====

	~~==== ====~~

	'''konstruktor'''		'''konstruktor'''

Bajkvl: /* Další společné funkce */

2009-09-24T08:43:57Z

Další společné funkce

← Starší verze		Verze z 24. 9. 2009, 10:43
Řádek 405:		Řádek 405:
	Při tvorbě úloh pro plánovač jsou k dispozici také další funkce a procedury uložené v souboru /scheduler/includes/CommonFunctions.php. Zde je jejich reference:		Při tvorbě úloh pro plánovač jsou k dispozici také další funkce a procedury uložené v souboru /scheduler/includes/CommonFunctions.php. Zde je jejich reference:

	* ''ReplaceBody ( inNewsId, inNewBody )''�- nahrazuje tělo zprávy s ID ''inNewsId'' textem ''inNewBody'' včetně ošetření, zda jde o zprávu uloženou v databázi nebo na disku		* ''ReplaceBody ( inNewsId, inNewBody )''
	* ''replaceNewsBodyInDB ( inNewsId, inNewBody )''�- interní procedura využívaná procedurou ''ReplaceBody''; nahrazuje v databázi tělo zprávy s ID ''inNewsId'' textem ''inNewBody''		- nahrazuje tělo zprávy s ID ''inNewsId'' textem ''inNewBody'' včetně ošetření, zda jde o zprávu uloženou v databázi nebo na disku
	* ''replaceNewsBodyInFile ( inNewsId, inNewBody )''�- interní procedura využívaná procedurou ''ReplaceBody''; nahrazuje v souboru tělo zprávy s ID ''inNewsId'' textem ''inNewBody''		* ''replaceNewsBodyInDB ( inNewsId, inNewBody )''
	* ''getPathToNewsFile ( inNewsId )''�- načítá z databáze podle ID (''inNewsId'') cestu ke zprávě z db pole NEWSDB:CESTA		- interní procedura využívaná procedurou ''ReplaceBody''; nahrazuje v databázi tělo zprávy s ID ''inNewsId'' textem ''inNewBody''
	* ''makeTextsPath ( newsPath )''�- přidává před předanou cestu ''newsPath'' cestu do adresáře s texty		* ''replaceNewsBodyInFile ( inNewsId, inNewBody )''
	* ''generateSinglePage ( inPageId )''�- přegenerovává stránku s ID ''inPageId''		- interní procedura využívaná procedurou ''ReplaceBody''; nahrazuje v souboru tělo zprávy s ID ''inNewsId'' textem ''inNewBody''
			* ''getPathToNewsFile ( inNewsId )''
			- načítá z databáze podle ID (''inNewsId'') cestu ke zprávě z db pole NEWSDB:CESTA
			* ''makeTextsPath ( newsPath )''
			- přidává před předanou cestu ''newsPath'' cestu do adresáře s texty
			* ''generateSinglePage ( inPageId )''
			- přegenerovává stránku s ID ''inPageId''

Bajkvl: /* */

2009-09-24T08:43:07Z

← Starší verze		Verze z 24. 9. 2009, 10:43
Řádek 396:		Řádek 396:
	<nowiki>?></nowiki>		<nowiki>?></nowiki>
	</code>		</code>

	~~==== ====~~

	=== Třídy pro přístup k databázi a souborům ===		=== Třídy pro přístup k databázi a souborům ===

Bajkvl: /* */

2009-09-24T08:42:52Z

← Starší verze		Verze z 24. 9. 2009, 10:42
Řádek 396:		Řádek 396:
	<nowiki>?></nowiki>		<nowiki>?></nowiki>
	</code>		</code>

	~~==== ====~~

	==== ====		==== ====

Bajkvl: /* Vytvoření zákaznické úlohy */

2009-09-24T08:38:04Z

Vytvoření zákaznické úlohy

← Starší verze		Verze z 24. 9. 2009, 10:38
Řádek 264:		Řádek 264:
	<nowiki></nowiki>		<nowiki></nowiki>
	</code>		</code>
	'''Vytvoření XML definice úlohy		'''Vytvoření XML definice úlohy'''

	~~'''~~Do souboru ''_registration_node.xml'' patří kód určující název úlohy, cestu ke spouštěnému skriptu, formulář administračního rozhraní a jednotlivé parametry úlohy. Kód definice pro příkladovou úlohu ''msg_count'' je následující:		Do souboru ''_registration_node.xml'' patří kód určující název úlohy, cestu ke spouštěnému skriptu, formulář administračního rozhraní a jednotlivé parametry úlohy. Kód definice pro příkladovou úlohu ''msg_count'' je následující:

	<code>		<code>

Bajkvl: /* Vytvoření zákaznické úlohy */

2009-09-24T08:36:59Z

Vytvoření zákaznické úlohy

← Starší verze		Verze z 24. 9. 2009, 10:36
Řádek 159:		Řádek 159:

	Význam formulářových polí je následující (uvědomme si technické řešení administrační části – formuláře všech typů úloh jsou umístěny v jednom html kódu a pouze přepínány):		Význam formulářových polí je následující (uvědomme si technické řešení administrační části – formuláře všech typů úloh jsou umístěny v jednom html kódu a pouze přepínány):

	~~<code>~~
	~~<nowiki></nowiki>~~
	~~</code>~~

	Přiřazení názvu úlohy k pořadovému číslu formuláře:		Přiřazení názvu úlohy k pořadovému číslu formuláře:

	<~~code~~>		:<tt><nowiki><input type="hidden" value="'.$inTaskId.'" name="tid'. $inTaskOrder .'"></nowiki></tt.
	<nowiki><input type="hidden" value="'.$inTaskId.'" name="tid'. $inTaskOrder .'"></nowiki>
	</~~code>~~

	Určení celkového počtu parametrů úlohy (zde 2 parametry):		Určení celkového počtu parametrů úlohy (zde 2 parametry):

	<~~code~~>		:<tt><nowiki><input type="hidden" value="2" name="par'. $inTaskOrder .'"></nowiki></tt>
	<nowiki><input type="hidden" value="2" name="par'. $inTaskOrder .'"></nowiki>
	</~~code~~>

	Pole pro vložení hodnoty n-tého parametru:		Pole pro vložení hodnoty n-tého parametru:

	<~~code~~>		:<tt><nowiki><input type="text" value="" name="h'. $inTaskOrder .'_n"></nowiki></tt>
	<nowiki><input type="text" value="" name="h'. $inTaskOrder .'_n"></nowiki>
	</~~code~~>

	Pole pro vložení komentáře k n-tému parametru (komentář není v současné verzi využíván):		Pole pro vložení komentáře k n-tému parametru (komentář není v současné verzi využíván):

	<~~code~~>		:<tt><nowiki><input type="hidden" value="comment '" name="p'. $inTaskOrder .'_n"></nowiki></tt>
	<nowiki><input type="hidden" value="comment '" name="p'. $inTaskOrder .'_n"></nowiki>
	</~~code~~>

	Pole pro určení datového typu n-tého parametru (zde se jedná o řetězec):		Pole pro určení datového typu n-tého parametru (zde se jedná o řetězec):

	<~~code~~>		:<tt><nowiki><input type="hidden" value="string" name="v'. $inTaskOrder .'_n"></nowiki></tt>
	<nowiki><input type="hidden" value="string" name="v'. $inTaskOrder .'_n"></nowiki>
	</~~code~~>

	Pozn.: Jestliže v XML definici úlohy neuvedete odkaz na takovýto formulář pro zadávání parametrů, úloha bude přesto editovatelná – v administrační části bude použit jednoduchý automaticky vygenerovaný formulář.		Pozn.: Jestliže v XML definici úlohy neuvedete odkaz na takovýto formulář pro zadávání parametrů, úloha bude přesto editovatelná – v administrační části bude použit
			jednoduchý automaticky vygenerovaný formulář.

	~~<code>~~		Vytvoření lokalizačních konstant
	~~<nowiki></nowiki>~~
	~~</code>~~

	~~Vytvoření lokalizačních konstant �Do~~ lokalizačního souboru ( /rdata/resources/webtodate/scheduler/tasks/''msg_count''/_localization_inc.php ) je potřeba umístit lokalizované texty použité ve formuláři a hlášení o výsledku úlohy. Kód pro příkladovou úlohu ''msg_count'' je následující:		Do lokalizačního souboru ( /rdata/resources/webtodate/scheduler/tasks/''msg_count''/_localization_inc.php ) je potřeba umístit lokalizované texty použité ve formuláři a hlášení o výsledku úlohy. Kód pro příkladovou úlohu ''msg_count'' je následující:

	<code>		<code>
Řádek 225:		Řádek 210:
	</code>		</code>

	Vytvoření samotného výkonného skriptu úlohy�Do souboru ''task_msg_count.php'' patří kód, který bude vykonán při spouštění.�V něm je nutné inicializovat novou instanci třídy ActiveTask, která umožňuje přístup k zadaným parametrům úlohy, ale lze také pomoci ní určit výsledek úlohy. Pomocí metody ''setAuxNote( string:message )'' lze navíc informovat uživatele o průběhu úlohy; s každým jejím voláním se uživateli zobrazí předané hlášení o vykonávané činnosti, o průběhu apod.�Kód skriptu příkladové úlohy ''msg_count'' je následující:		Vytvoření samotného výkonného skriptu úlohy

			Do souboru ''task_msg_count.php'' patří kód, který bude vykonán při spouštění.

			V něm je nutné inicializovat novou instanci třídy ActiveTask, která umožňuje přístup k zadaným parametrům úlohy, ale lze také pomoci ní určit výsledek úlohy. Pomocí metody ''setAuxNote( string:message )'' lze navíc informovat uživatele o průběhu úlohy; s každým jejím voláním se uživateli zobrazí předané hlášení o vykonávané činnosti, o průběhu apod.

			Kód skriptu příkladové úlohy ''msg_count'' je následující:
	<code>		<code>
	<nowiki><?php</nowiki>		<nowiki><?php</nowiki>
Řádek 274:		Řádek 264:
	<nowiki></nowiki>		<nowiki></nowiki>
	</code>		</code>
			'''Vytvoření XML definice úlohy

	~~'''Vytvoření XML definice úlohy�~~'''Do souboru ''_registration_node.xml'' patří kód určující název úlohy, cestu ke spouštěnému skriptu, formulář administračního rozhraní a jednotlivé parametry úlohy. Kód definice pro příkladovou úlohu ''msg_count'' je následující:		'''Do souboru ''_registration_node.xml'' patří kód určující název úlohy, cestu ke spouštěnému skriptu, formulář administračního rozhraní a jednotlivé parametry úlohy. Kód definice pro příkladovou úlohu ''msg_count'' je následující:

	<code>		<code>
Řádek 312:		Řádek 303:
	</code>		</code>

	Doplnění XML definice do globálního souboru s definicemi úloh ~~Plánovače�Při~~ nastavování úlohy se v administračním rozhraní nabízejí všechny ty úlohy, jejichž definici obsahuje soubor /offlinedata/scheduler/''registration.xml''. Sem je tedy nutné vložit definici úlohy (obsah souboru ''_registration_node.xml''), a to na úroveň ostatních elementů ''task''.		Doplnění XML definice do globálního souboru s definicemi úloh Plánovače

			Při nastavování úlohy se v administračním rozhraní nabízejí všechny ty úlohy, jejichž definici obsahuje soubor /offlinedata/scheduler/''registration.xml''. Sem je tedy nutné vložit definici úlohy (obsah souboru ''_registration_node.xml''), a to na úroveň ostatních elementů ''task''.

	Toto jsou všechny kroky potřebné pro vytvoření úlohy pro Plánovač úloh.		Toto jsou všechny kroky potřebné pro vytvoření úlohy pro Plánovač úloh.

Bajkvl: /* Vytvoření zákaznické úlohy */

2009-09-23T13:07:05Z

Vytvoření zákaznické úlohy

← Starší verze		Verze z 23. 9. 2009, 15:07
Řádek 112:		Řádek 112:
	* chceme-li formulář úlohy v administrační části lokalizovat do několika jazyků, je navíc nutné vytvořit soubor pro lokalizační konstanty ( ''/rdata/resources/webtodate/scheduler/tasks/msg_count/_localization_inc.php ''), které budou v tomto formuláři použity.		* chceme-li formulář úlohy v administrační části lokalizovat do několika jazyků, je navíc nutné vytvořit soubor pro lokalizační konstanty ( ''/rdata/resources/webtodate/scheduler/tasks/msg_count/_localization_inc.php ''), které budou v tomto formuláři použity.
	* do adresáře je vhodné přidat také XML uzel s definicí úlohy ( ''_registration_node.xml '').		* do adresáře je vhodné přidat také XML uzel s definicí úlohy ( ''_registration_node.xml '').

	~~<code>~~
	~~<nowiki></nowiki>~~
	~~</code>~~

	Vytvoření formuláře pro administrační rozhraní		Vytvoření formuláře pro administrační rozhraní

Bajkvl: /* Vytvoření zákaznické úlohy */

2009-09-23T13:06:42Z

Vytvoření zákaznické úlohy

← Starší verze		Verze z 23. 9. 2009, 15:06
Řádek 106:		Řádek 106:
	Postup je demonstrován na příkladu – vytvoření plánované úlohy, která přebírá jeden parametr (ID zprávy) a obsah této zprávy pak nahrazuje oznámením o celkovém počtu publikovaných zpráv, přítomných v databázi aplikace WebToDate. Úloha se bude jmenovat ''msg_count''.		Postup je demonstrován na příkladu – vytvoření plánované úlohy, která přebírá jeden parametr (ID zprávy) a obsah této zprávy pak nahrazuje oznámením o celkovém počtu publikovaných zpráv, přítomných v databázi aplikace WebToDate. Úloha se bude jmenovat ''msg_count''.

	Vytvoření potřebných ~~souborů�V~~ příslušném nově vytvořeném adresáři ( ''/scheduler/tasks/custom/msg_count/ '') je nutné vytvořit soubory:		Vytvoření potřebných souborů. V příslušném nově vytvořeném adresáři ( ''/scheduler/tasks/custom/msg_count/ '') je nutné vytvořit soubory:

	* s kódem formuláře pro administračním rozhraní ( ''_tf_msg_count.php '')		* s kódem formuláře pro administračním rozhraní ( ''_tf_msg_count.php '')
Řádek 117:		Řádek 117:
	</code>		</code>

	Vytvoření formuláře pro administrační ~~rozhraní�Do~~ souboru ''_tf_msg_count.php'' patří kód tisknoucí formulář, jehož pomocí se úloha v Plánovači nastavuje. Kód formuláře příkladové úlohy ''msg_count'' je následující:		Vytvoření formuláře pro administrační rozhraní

			Do souboru ''_tf_msg_count.php'' patří kód tisknoucí formulář, jehož pomocí se úloha v Plánovači nastavuje. Kód formuláře příkladové úlohy ''msg_count'' je následující:

	<code>		<code>