re-add transition-effects (aka transition action triggers)

git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@5925 c91229c3-7414-0410-bfa2-8a42b809f60b

re-add transition-effects (aka transition action triggers)
git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@5925 c91229c3-7414-0410-bfa2-8a42b809f60b
Brad Shuttleworth
1 parent 13b327a0
Showing 5 changed files with 278 additions and 1 deletions
plugins/ktcore/KTWorkflowTriggers.inc.php
plugins/ktcore/admin/workflowsv2.php
templates/ktcore/workflow/admin/effects_overview.smarty
templates/ktcore/workflow/admin/transition_actions_edit.smarty
templates/ktcore/workflow/admin/transition_effects_overview.smarty
@@ -477,7 +477,7 @@ class CopyActionTrigger extends KTWorkflowTrigger {
  
         $qsFrag = array();
         foreach ($args as $k => $v) {
-            if ($k == 'action') { $v = 'editTrigger'; } // horrible hack - we really need iframe embedding. 
+            if ($k == 'action') { $v = 'editactiontrigger'; } // horrible hack - we really need iframe embedding. 
             $qsFrag[] = sprintf("%s=%s",urlencode($k), urlencode($v));
         }
         $qs = implode('&',$qsFrag);
@@ -1379,6 +1379,223 @@ class KTWorkflowAdminV2 extends KTAdminDispatcher {
         ));
         return $oTemplate->render();    
     }    
+    
+
+    function form_addtransitionaction() {
+        $oForm = new KTForm;
+        $oForm->setOptions(array(
+            'identifier' => 'ktcore.admin.workflow.addaction',
+            'label' => _kt("Add New Transition Action"),
+            'action' => 'addactiontrigger',
+            'cancel_action' => 'managetransitionactions',
+            'fail_action' => 'managetransitionactions', 
+            'submit_label' => _kt("Add Action"),
+            'context' => $this,
+        ));
+        
+        $oTriggerSingleton =& KTWorkflowTriggerRegistry::getSingleton();
+        $aTriggerList = $oTriggerSingleton->listWorkflowTriggers();
+        $vocab = array();
+        foreach ($aTriggerList as $ns => $aTriggerInfo) {
+            $aInfo = $aTriggerInfo; // i am lazy.
+            //var_dump($aInfo);
+            $actions = array();
+            if ($aInfo['guard']) {
+                $actions[] = _kt('Guard');
+            } 
+            if ($aInfo['action']) {
+                $actions[] = _kt('Action');
+            } else { 
+                continue;
+            }
+            $sActStr = implode(', ', $actions);
+            $vocab[$ns] = sprintf(_kt("%s (%s)"), $aInfo['name'], $sActStr);
+        }    
+        
+        $oForm->setWidgets(array(
+            array('ktcore.widgets.selection', array(
+                'label' => _kt("Action/Effect Type"),
+                'name' => 'action_name',
+                'vocab' => $vocab,
+                'simple_select' => false,
+                'required' => true,
+            )),
+        ));
+        
+        $oForm->setValidators(array(
+            array('ktcore.validators.string', array(
+                'test' => 'action_name',
+                'output' => 'action_name',
+            )),
+        ));
+        return $oForm;
+    }       
+
+    function do_transitionactions() {
+        $oTemplate = $this->oValidator->validateTemplate('ktcore/workflow/admin/transition_effects_overview');            
+        $this->oPage->setBreadcrumbDetails(_kt("Transition Effects"));
+        
+        $aTransitions = KTWorkflowTransition::getByWorkflow($this->oWorkflow);
+                
+        $oTemplate->setData(array(
+            'context' => $this,
+            'transitions' => $aTransitions,
+       ));
+        return $oTemplate->render();    
+    }           
+    
+    
+    // helper
+    function describeTransitionActions($oTransition) {
+        $actions = KTWorkflowUtil::getActionTriggersForTransition($oTransition);
+        
+        if (empty($actions)) {
+            return '&mdash;';
+        }
+        
+        $action_text = array();
+        foreach ($actions as $oAction) {
+            $action_text[] = $oAction->getConfigDescription();
+        }
+        
+        return implode('. ', $action_text);
+    }
+    
+
+    function do_managetransitionactions() {
+        $oTemplate = $this->oValidator->validateTemplate('ktcore/workflow/admin/transition_actions_edit');            
+        $this->oPage->setBreadcrumbDetails(_kt("Actions"));
+        
+        $actions = KTWorkflowUtil::getActionTriggersForTransition($this->oTransition);
+        $add_form = $this->form_addtransitionaction();
+        
+        $oTemplate->setData(array(
+            'context' => $this,
+            'add_form' => $add_form,
+            'aActionTriggers' => $actions,
+        ));
+        return $oTemplate->render();    
+    }       
+    
+    function do_addactiontrigger() {
+        $oForm = $this->form_addtransitionaction();
+        $res = $oForm->validate();
+        $data = $res['results'];
+        $errors = $res['errors'];
+        
+        if (!empty($errors)) {
+            return $oForm->handleError();
+        }
+
+        $KTWFTriggerReg =& KTWorkflowTriggerRegistry::getSingleton();
+
+        $this->startTransaction();
+
+        $oTrigger = $KTWFTriggerReg->getWorkflowTrigger(KTUtil::arrayGet($data, 'action_name'));
+        if (PEAR::isError($oTrigger)) {
+            return $oForm->handleError(_kt('Unable to add trigger.'));
+        }
+
+        $oTriggerConfig = KTWorkflowTriggerInstance::createFromArray(array(
+            'transitionid' => KTUtil::getId($this->oTransition),
+            'namespace' =>  KTUtil::arrayGet($data, 'action_name'),
+            'config' => array(),
+        ));
+        
+        if (PEAR::isError($oTriggerConfig)) {
+            return $oForm->handleError(_kt('Unable to add trigger.') . $oTriggerConfig->getMessage());
+        }
+
+        // now, if the trigger is editable...
+        $oTrigger->loadConfig($oTriggerConfig);
+        if ($oTrigger->bIsConfigurable) {
+            $this->successRedirectTo('editactiontrigger', _kt("New action added. This action requires configuration:  please specify this below."), array('fTriggerInstanceId' => $oTriggerConfig->getId()));        
+        } else {
+            $this->successRedirectTo('managetransitionactions', _kt("New restriction added."));
+        }
+        exit(0);        
+    }
+    
+    
+    function do_editactiontrigger() {
+        $this->oPage->setBreadcrumbDetails(_kt('editing restriction'));
+        $oTriggerInstance =& KTWorkflowTriggerInstance::get($_REQUEST['fTriggerInstanceId']);        
+        if (PEAR::isError($oTriggerInstance)) {
+            return $this->errorRedirectTo('managetransitionactions', _kt('Unable to load trigger.'));
+        }
+
+        // grab the transition ns from the request.
+        $KTWFTriggerReg =& KTWorkflowTriggerRegistry::getSingleton();
+
+        $this->startTransaction();
+
+        $oTrigger = $KTWFTriggerReg->getWorkflowTrigger($oTriggerInstance->getNamespace());
+        if (PEAR::isError($oTrigger)) {
+            $this->errorRedirectTo('managetransitionactions', _kt('Unable to add trigger.'), 'fWorkflowId=' . $oWorkflow->getId() . '&fTransitionId=' .  $oTransition->getId());
+            exit(0);
+        }
+        $oTrigger->loadConfig($oTriggerInstance);
+
+        return $oTrigger->displayConfiguration($this->meldPersistQuery(array('fTriggerInstanceId' => $oTriggerInstance->getId()), 'saveactiontrigger', true));
+    }
+
+    // }}}
+
+    function do_saveactiontrigger() {
+        $oTriggerInstance =& KTWorkflowTriggerInstance::get($_REQUEST['fTriggerInstanceId']);        
+        if (PEAR::isError($oTriggerInstance)) {
+            $this->errorRedirectTo('managetransitionactions', _kt('Unable to load trigger.'));
+            exit(0);        
+        }
+        
+        $KTWFTriggerReg =& KTWorkflowTriggerRegistry::getSingleton();
+
+        $this->startTransaction();
+
+        $oTrigger = $KTWFTriggerReg->getWorkflowTrigger($oTriggerInstance->getNamespace());
+        if (PEAR::isError($oTrigger)) {
+            $this->errorRedirectTo('managetransitionactions', _kt('Unable to load trigger.'));
+            exit(0);
+        }
+        $oTrigger->loadConfig($oTriggerInstance);
+        
+        $res = $oTrigger->saveConfiguration();
+        if (PEAR::isError($res)) {
+            $this->errorRedirectTo('managetransitionactions', _kt('Unable to save trigger: ') . $res->getMessage());
+            exit(0);            
+        }
+    
+        $this->successRedirectTo('managetransitionactions', _kt('Trigger saved.'));
+        exit(0);    
+    }
+
+    function do_deleteactiontrigger() {
+        $oTriggerInstance =& KTWorkflowTriggerInstance::get($_REQUEST['fTriggerInstanceId']);        
+        if (PEAR::isError($oTriggerInstance)) {
+            return $this->errorRedirectTo('managetransitionactions', _kt('Unable to load trigger.'));
+        }
+
+        // grab the transition ns from the request.
+        $KTWFTriggerReg =& KTWorkflowTriggerRegistry::getSingleton();
+        $this->startTransaction();
+
+        $oTrigger = $KTWFTriggerReg->getWorkflowTrigger($oTriggerInstance->getNamespace());
+        if (PEAR::isError($oTrigger)) {
+            $this->errorRedirectTo('managetransitionactions', _kt('Unable to load trigger.'));
+            exit(0);
+        }
+        $oTrigger->loadConfig($oTriggerInstance);
+        
+        $res = $oTriggerInstance->delete();
+        if (PEAR::isError($res)) {
+            $this->errorRedirectTo('managetransitionactions', _kt('Unable to delete trigger: ') . $res->getMessage(), 'fWorkflowId=' . $oWorkflow->getId() . '&fTransitionId=' .  $oTransition->getId());
+            exit(0);            
+        }
+    
+        $this->successRedirectTo('managetransitionactions', _kt('Trigger deleted.'));
+        exit(0);    
+    }
+    
 }
  
 ?>
@@ -5,3 +5,8 @@ varies other actions to occur.  For example, you can attach a &quot;Move&quot; action to a
 which will cause any document moving through that workflow to be moved to a particular folder. 
 Or you can specify that when a document reaches the "Pending Review" state, users
 with the role "Reviewer" on that document are informed.</p>
+
+<ul class="descriptiveText">
+    <li><a href="{addQS context=$context}action=transitionactions{/addQS}">Transition Effects</a></li>
+    <li><a href="{addQS context=$context}action=statenotifications{/addQS}">Notifications</a></li>    
+</ul>
+<h2>{i18n}Transition Effects{/i18n}</h2>
+    
+{$add_form->render()}
+    
+<br />    
+    
+{if empty($aActionTriggers)}
+  <div class="ktInfo"><p>{i18n}This transition has no actions associated with it..{/i18n}</p></div>    
+{else}
+    
+<table class="kt_collection narrow" cellspacing="0">
+    <thead>
+        <tr>
+            <th>{i18n}Action{/i18n}</th>        
+            <th>{i18n}Edit{/i18n}</th>        
+            <th>{i18n}Delete{/i18n}</th>                                          
+            <th>{i18n}Configuration{/i18n}</th>                    
+        </tr>    
+    </thead>    
+    <tbody>
+        {foreach from=$aActionTriggers item=oTrigger}
+         <tr>
+             <td>{$oTrigger->getName()}</td>
+             <td>{if $oTrigger->bIsConfigurable}<a class="ktAction ktEdit" href="{addQS context=$context}action=editactiontrigger&fTriggerInstanceId={$oTrigger->getConfigId()}{/addQS}">edit</a>{else}&mdash;{/if}</td>
+             <td><a class="ktAction ktDelete" href="{addQS context=$context}action=deleteactiontrigger&fTriggerInstanceId={$oTrigger->getConfigId()}{/addQS}">delete</a></td>                                       
+             <td>{$oTrigger->getConfigDescription()}</td>             
+         </tr>
+        {/foreach}    
+    </tbody>
+    </table>    
+    
+    {/if}
+<h2>Transition Actions Overview</h2>
+
+<p class="descriptiveText important">Please note that the plugins that are installed
+will affect the available options</p>
+
+<table class="kt_collection narrow" cellspacing="0">
+    <thead>
+        <th>Transition</th>
+        <th>Edit</th>
+        <th>Effects</th>        
+    </thead>
+    
+    <tbody>
+      {foreach from=$transitions item=oTransition}
+      {assign value=$oTransition->getId() var=transition_id}
+        <tr>
+            <td>{$oTransition->getName()}</td>
+            <td class="centered"><a href="{addQS context=$context}action=managetransitionactions&fTransitionId={$transition_id}{/addQS}" class="ktAction ktEdit"></a></td>
+            <td><span class="descriptiveText">{$context->describeTransitionActions($oTransition)}</span></td>
+        </tr>
+      {/foreach}
+    </tbody>
+</table>