workflowtrigger.inc.php
3.97 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<?php
/**
* $Id: workflowtrigger.inc.php 5268 2006-04-18 13:42:22Z nbm $
*
* Provides a base class for workflow triggers. This includes
* the ability to serialise configuration arrays into the db
* and to be restored.
*
* This class will be subclassed - any configuration that is performed
* should be saved through the associated KTWorkflowTriggerInstance.
*
* Copyright (c) 2005 Jam Warehouse http://www.jamwarehouse.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; using version 2 of the License.
*
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @version $Revision: 5268 $
* @author Brad Shuttleworth, Jam Warehouse (Pty) Ltd, South Africa
*/
//require_once(KT_LIB_DIR . '/workflow/workflowtriggerinstance');
class KTWorkflowTrigger {
var $sNamespace = 'ktcore.workflowtriggers.abstractbase';
var $sFriendlyName;
var $sDescription;
var $oTriggerInstance;
var $aConfig = array();
// generic requirements - both can be true
var $bIsGuard = false;
var $bIsAction = false;
function KTWorkflowTrigger() {
$this->_oTriggerState = null; // initialise to initial state
$this->sFriendlyName = _kt('Base class for workflow triggers');
$this->sDescription = _kt('This is an abstract base class for the overall workflow trigger. It should never actually be available for installation.');
}
function loadConfig($oTriggerInstance) {
$this->oTriggerInstance = $oTriggerInstance;
$this->aConfig = $oTriggerInstance->getConfig();
}
function isLoaded() { return (!is_null($this->oTriggerInstance)); }
// simple function to inform the UI/registration what kind of event this is
function getInfo() {
return array(
'guard' => $this->bIsGuard,
'action' => $this->bIsAction,
'name' => $this->sFriendlyName,
'description' => $this->sDescription,
);
}
function getName() { return $this->sFriendlyName; }
function getNamespace() { return $this->sNamespace; }
function getConfigId() { return $this->oTriggerInstance->getId(); }
// return true for transition allowed on doc, false for transition not allowed on doc.
function allowTransition($oDocument, $oUser) {
return true; // abstract base class
}
// perform more expensive checks -before- performTransition.
function precheckTrigger($oDocument, $oUser) {
return true;
}
/*
Multiple triggers can occur on a given transition. If this trigger fails,
return a PEAR::error (the overall system -will- roll the db back -
no need to do it yourself) with a -useful- human error message.
Any other return is simply discarded.
*/
function performTransition($oDocument, $oUser) {
return true;
}
// display the configuration page for this plugin
// will be called -after- loadConfig, so it can prepopulate the options.
function displayConfiguration($args) {
return _kt('No configuration has been implemented for this plugin.');
}
// dispatched - again, after loadConfig, so it can set the config.
// throw an error to redispatch displayConfiguration, or return true to cause a db commit (probably).
function saveConfiguration() {
return true;
}
// give a brief, friendly description of what we are and what we do.
function getConfigDescription() {
return '';
}
}
?>