Changeset 1293 for sandbox/workflow/2.0/inc/class.ui_agent.inc.php

Timestamp:

08/07/09 16:06:07 (15 years ago)

Author:

gbisotto

Message:

Ticket #609 - Modificada a classe Factory e ProcessFactory? para automatizaro acesso ao objetos

File:

• sandbox/workflow/2.0/inc/class.ui_agent.inc.php (modified) (19 diffs)

sandbox/workflow/2.0/inc/class.ui_agent.inc.php

@@ -11 +11 @@
 
 /**
- * Agents abstraction library. interface layer. 
+ * 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
@@ -17 +17 @@
  * 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
  * @license http://www.gnu.org/copyleft/gpl.html GPL
@@ -23 +23 @@
  */
 require_once(dirname(__FILE__) . SEP . 'class.WorkflowUtils.inc.php');
-        
+
 class ui_agent extends WorkflowUtils
 {
@@ -39 +39 @@
          * @var bool $interactivity for runtime mode
          * @access public
-         */ 
+         */
         var $interactivity = false;
-        
+
         // concerning Child classes constructors ---------------------------------------------
         /**
          * @var object bo_agent object which have to be set in your child class to the right bo_agent child
-         * @access public  
+         * @access public
          */
         var $bo_agent = null;
@@ -54 +54 @@
         var $agent_type = '';
         // -----------------------------------------------------------------------------------
-        
+
         /**
          * Constructor
@@ -64 +64 @@
                 parent::WorkflowUtils();
         }
-        
+
         /**
          * Function which must be called (internally) at runtime .The agent MUST know if he is runned in an interactive activity or not.
@@ -79 +79 @@
          * Return errors recorded by this object
          * You should always call this function after failed operations on a workflow object to obtain messages
-         * @param array $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 
+         * @param array $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.
          * @access public
-         * @return array errors 
-         */
-         function get_error($as_array=false) 
+         * @return array errors
+         */
+         function get_error($as_array=false)
          {
                 $this->error[] = $this->bo_agent->get_error();
@@ -95 +95 @@
                 return $result_str;
                 }
-                        
+
         /**
          * Factory: load the agent values stored somewhere via the agent bo object
@@ -106 +106 @@
                 return ( (isset($this->bo_agent)) && ($this->bo_agent->load($agent_id)));
         }
-        
+
         /**
          * Save the agent values somewhere via the agent bo object
@@ -116 +116 @@
         {
                 if (!(isset($this->bo_agent)))
-                { 
+                {
                         return false;
                 }
@@ -131 +131 @@
          * we store references to theses objects and we tell the ui object if we are in interactive
          * mode or not.
-         * @param array    $instance 
+         * @param array    $instance
          * @param object   $activity activity
          * @return void
@@ -141 +141 @@
                 $this->setInteractivity($activity->isInteractive());
         }
-        
+
         /**
          * This function show the shared part of all agents when showing configuration in the admin activity form
@@ -147 +147 @@
          * @param string $template_block_name
          * @return void
-         * @access public 
+         * @access public
          */
         function showAdminActivityOptions ($template_block_name)
-        { 
+        {
                 $admin_name = 'admin_agent_shared';
                 $this->t->set_file($admin_name, $admin_name . '.tpl');
@@ -161 +161 @@
                 $this->t->parse($template_block_name, $admin_name);
         }
-        
+
         /**
          * Function called by the running object (run_activity) after the activity_pre code
@@ -177 +177 @@
                 return true;
         }
-        
+
         /**
          * Function called by the running object (run_activity) after the activity_pre code
@@ -190 +190 @@
                 return true;
         }
-        
+
         /**
          * 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)
@@ -200 +200 @@
          * user code after completion.
          * @return bool true or false, if false the $this->error array should contains error messages
-         * @access public 
+         * @access public
          */
         function run_activity_completed_pos()
@@ -206 +206 @@
                 return true;
         }
-        
+
    /**
         *  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)
@@ -222 +222 @@
                 return true;
         }
-        
+
         /**
          * Retrieve infos set by the user in interactive forms ans store it with the bo_agent object