Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision 		Previous revision
en:start:task_management [2016/07/07 14:54]
admin created 		en:start:task_management [2016/07/07 15:01]
admin [WfTask*.php]
Line 20: Line 20:
 The Workflow Designer will ask you some questions, how you would define the new task. The Workflow Designer will ask you some questions, how you would define the new task.
  
-  - **The key** +  - **The key** \\ This is the slug of the Block, which will be used to store the relation in the database. Must be unique! 
-This is the slug of the Block, which will be used to store the relation in the database. Must be unique! +  - **The classname** ​\\ Must be a value with the Prefix “WfTask”. For example ​**WfTaskNewBlock**. This is the classname of the new block. 
-  - **The classname** +  - **The label** ​\\ The label, visible in the sidebar and below every block. Should describe the function of this block.
-Must be a value with the Prefix “WfTask”. For example WfTaskNewBlock. This is the classname of the new block. +
-  - **The label** +
-The label, visible in the sidebar and below every block. Should describe the function of this block.+
  
-Then the Workflow Designer will create the necessary files.+Then the Workflow Designer will create the necessary files. ​\\
 the block will create in the task group “special tools”. the block will create in the task group “special tools”.
  
Line 37: Line 34:
 </​WRAP>​ </​WRAP>​
  
 +This file must have a special structure.
 +
 +<​Code>​
 +<?php
 +require_once(realpath(dirname(__FILE__).'/​../​autoload_wf.php'​));​
 + 
 +class dummyTypeClass extends \Workflow\Task
 +{
 +    public function handleTask(&​$context) {
 +        /* Insert here source code to execute the task */
 + 
 +        return "​yes";​
 +    }
 + 
 +    public function beforeGetTaskform($viewer) {
 +        /* Insert here source code to create custom configurations pages */
 +    }
 +    public function beforeSave(&​$values) {
 +        /* Insert here source code to modify the values the user submit on configuration */
 +    }
 +}
 +</​Code>​
 +
 +The require_once will make sure all Workflow related functions are available. \\
 +This line is important, because later I will make sure you could call every type externally.
 +
 +**handleTask(&​$context)**
 +
 +This function will be executed every time the task will be executed and must include all php code you want to run in this situation. (But you could also include external files like in every other php script) \\
 +This function MUST have a return value, which is equal to one of the output points you configure in task.xml. \\
 +The parameter is from the Type \Workflow\VTEntity,​ which will be explained [[http://​swarnat.github.io/​Workflow-Designer-Developer/​classes/​classes/​Workflow.VTEntity.html|Here]].
 +
 +**beforeGetTaskform($viewer)**
 +
 +This function will be called before the configuration popup is shown. You could prepare all dependencies and assign values to the $viewer parameter, which is the Smarty Object used for the popup.
 +
 +**beforeSave(&​$values)
 +**
 +This function will be called before the configuration values are saved. The **$values** variable is an array with the submitted fields in the **task** variable.
 +
 +==== WfTask*.js ====
 +<WRAP center tip 100%>
 +You found below /​modules/​Workflow2/​tasks/​.
 +</​WRAP>​
 +
 +Will be loaded in the configuration popup and could handle all functions for this window.
 +
 +==== WfTask*.tpl ====
 +<WRAP center tip 100%>
 +You found below /​layouts/​vlayout/​modules/​Settings/​Workflow2/​tasksforms/​ \\
 +The wildcard will be replaced by the task key for this file and not the classname.
 +</​WRAP>​
 +
 +The configuration template. \\
 +There exists an open <form Tag, which will store any value you write to the task[…] variable and give this value also back to the template.