| [ Index ] |
|
Code source de eGroupWare 1.2.106-2 |
[Code source] [Imprimer] [Statistiques]
* Agents abstraction library. interface layer * * This allows the Workflow Engine to connect to various agents * Agents are external elements for the workflow. It could be * email systems, filesystems, calendars, what you want. * Use this class to make childrens like, for example in the * class.ui_agent_mail_smtp.inc.php for the mail_smtp susbsytem * * @package workflow * @author regis.leroy@glconseil.com * GPL
| Poids: | 218 lignes (8 kb) |
| Inclus ou requis: | 0 fois |
| Référencé: | 0 fois |
| Nécessite: | 0 fichiers |
ui_agent:: (12 méthodes):
ui_agent()
setInteractivity()
get_error()
load()
save()
runtime()
showAdminActivityOptions()
run_activity_pre()
run_leaving_activity_pre()
run_activity_completed_pos()
run_activity_pos()
retrieve_form_settings()
| ui_agent() X-Ref |
| Pas de description |
| setInteractivity($bool) X-Ref |
| Function which must be called (internally) at runtime * The agent MUST know if he is runned in an interactive activity or not. * For example on non-interactive activities the agents musn't scan the POST content |
| get_error($as_array=false) X-Ref |
| * You should always call this function after failed operations on a workflow object to obtain messages * @param $as_array if true the result will be send as an array of errors or an empty array. Else, if you do not give any parameter * or give a false parameter you will obtain a single string which can be empty or will contain error messages with <br /> html tags. |
| load($agent_id) X-Ref |
| * Factory: load the agent values stored somewhere via the agent bo object * @param $agent_id is the agent id * @return false if the agent cannot be loaded, true else |
| save(&$datas) X-Ref |
| * save the agent values somewhere via the agent bo object * @param $datas is an array containing comlumns => value pairs * @return false if the agent was not previously loaded or if the save fail, true else |
| runtime(&$instance, &$activity) X-Ref |
| * Function called at runtime to permit associtaion with the instance and the activity * we store references to theses objects and we tell the ui object if we are in interactive * mode or not. |
| showAdminActivityOptions($template_block_name) X-Ref |
| * this function show the shared part of all agents when showing * * configuration in the admin activity form * do not forget to call parent::showAdminActivityOptions ($template_block_name) * in the child if you want to display this shared part * @return |
| run_activity_pre() X-Ref |
| * Function called by the running object (run_activity) after the activity_pre code * * and before the user code. This code is runned only if the $GLOBALS['workflow']['__leave_activity'] * IS NOT set (i.e.: the user is not cancelling his form in case of interactive activity) * WARNING : on interactive queries the user code is parsed several times and this function is called * each time you reach the begining of the code, this means at least the first time when you show the form * and every time you loop on the form + the last time when you complete the code (if the user did not cancel). * @return true or false, if false the $this->error array should contains error messages |
| run_leaving_activity_pre() X-Ref |
| * Function called by the running object (run_activity) after the activity_pre code * * and before the user code. This code is runned only if the $GLOBALS['workflow']['__leave_activity'] * IS set (i.e.: the user is cancelling his form in case of interactive activity) * @return true or false, if false the $this->error array should contains error messages |
| run_activity_completed_pos() X-Ref |
| * Function called by the running object (run_activity) after the user code * * and after the activity_pos code. This code is runned only if the $GLOBALS['__activity_completed'] * IS NOT set (i.e.: the user is not yet completing the activity) * WARNING : on automatic (non-interactive) activities this code is NEVER called. Non-interactive * activities are completed after the end of the user code and there is no way to re-parse this * user code after completion. * @return true or false, if false the $this->error array should contains error messages |
| run_activity_pos() X-Ref |
| * Function called by the running object (run_activity) after the user code * * and after the activity_pos code. This code is runned only if the $GLOBALS['__activity_completed'] * IS set (i.e.: the user has completing the activity) * WARNING : on interactive queries the user code is parsed several times and this function is called * each time you reach the end of the code without completing, this means at least the first time * and every time you loop on the form. * @return true or false, if false the $this->error array should contains error messages |
| retrieve_form_settings() X-Ref |
| retrieve infos set by the user in interactive forms * ans store it with the bo_agent object |
| Généré le : Sun Feb 25 17:20:01 2007 | par Balluche grâce à PHPXref 0.7 |