| [ Index ] |
|
Code source de eGroupWare 1.2.106-2 |
[Code source] [Imprimer] [Statistiques]
(pas de description)
| Poids: | 246 lignes (7 kb) |
| Inclus ou requis: | 0 fois |
| Référencé: | 0 fois |
| Nécessite: | 0 fichiers |
bo_agent:: (13 méthodes):
bo_agent()
get_error()
getTitle()
getDescription()
getHelp()
load()
save()
runtime()
get()
set()
listProcessConfigurationFields()
getProcessConfigurationFields()
getAdminActivityOptions()
| bo_agent() X-Ref |
| Pas de description |
| 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. |
| getTitle() X-Ref |
| Pas de description |
| getDescription() X-Ref |
| Pas de description |
| getHelp() X-Ref |
| Pas de description |
| load($agent_id, $really_load=true) X-Ref |
| * Factory: Load the agent values stored somewhere in the agent object and retain the agent id * * @param $agent_id is the agent id * @param $really_load boolean, true by default, if false the data wont be loaded from database and * the only thing done by this function is storing the agent_id (usefull if you know you wont need actual data) * @return false if the agent cannot be loaded, true else |
| save() X-Ref |
| * Save the agent datas * * @return false if the agent cannot be saved, true else |
| runtime(&$instance, &$activity) X-Ref |
| * Function called at runtime to permit association with the instance and the activity * we store references to theses objects |
| get($result_type) X-Ref |
| * Return the agent fields in different forms * @param $result_type int : * 1 the result is an array containing the field names * 2 the result is an array containing fields names => value pairs * 3 the result is an array containing fields names => field array pairs, the field array is an associative array containing all infos about the field with $key => $value pairs. * @return an array, the form depends on the parameter $result_type |
| set(&$datas) X-Ref |
| * Affect some values to some of the agent's fields * @param $datas is an array containing fields => value pairs * @return false if one or more value cannot be affected, true else |
| listProcessConfigurationFields() X-Ref |
| * this function tell the engine which process level options have to be set * * for the agent. Theses options will be initialized for all processes by the engine * and can be different for each process. * @return an array which can be empty |
| getProcessConfigurationFields($wf_p_id, $force=false) X-Ref |
| * This function retrieve process level configuration otpions set by the engine * for the agent. Theses conf values are cached locally for the object life duration * @param $wf_p_id is the process id * @param $force is false by default, if true we retrieve theses config values even if the $conf * local cache is already set * @return an associative array which can be empty |
| getAdminActivityOptions() X-Ref |
| * this function lists activity level options avaible for the agent * * @return an associative array which can be empty |
| Généré le : Sun Feb 25 17:20:01 2007 | par Balluche grâce à PHPXref 0.7 |