fix for KTS-949 : Workflow viewlet

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

fix for KTS-949 : Workflow viewlet
git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@5947 c91229c3-7414-0410-bfa2-8a42b809f60b
Brad Shuttleworth
1 parent b4b411bb
Showing 6 changed files with 159 additions and 2 deletions
plugins/ktcore/KTCorePlugin.php
plugins/ktcore/KTDocumentActions.php
plugins/ktcore/KTDocumentViewlets.php
templates/ktcore/document/view.smarty
templates/ktcore/document/viewlets/download.smarty
templates/ktcore/document/viewlets/workflow.smarty
@@ -67,6 +67,10 @@ class KTCorePlugin extends KTPlugin {
         $this->registerAction('documentaction', 'KTDocumentAssistAction', 'ktcore.actions.document.assist', 'KTAssist.php');
         // $this->registerAction('folderaction', 'KTDocumentAssistAction', 'ktcore.actions.folder.assist', 'KTAssist.php');
  
+        // Viewlets
+        $this->registerAction('documentviewlet', 'KTWorkflowViewlet', 'ktcore.viewlets.document.workflow', 'KTDocumentViewlets.php');        
+
+
         $this->registerNotificationHandler('KTAssistNotification', 'ktcore/assist', 'KTAssist.php');
         $this->registerNotificationHandler("KTSubscriptionNotification", "ktcore/subscriptions", KT_LIB_DIR . '/dashboard/Notification.inc.php');
         $this->registerNotificationHandler("KTWorkflowNotification", "ktcore/workflow", KT_LIB_DIR . '/dashboard/Notification.inc.php');
@@ -1303,6 +1303,10 @@ class KTDocumentWorkflowAction extends KTDocumentAction {
  
     var $sHelpPage = 'ktcore/user/workflow.html';    
  
+    function predispatch() {
+        $this->persistParams(array("fTransitionId"));    
+    }
+
     function getDisplayName() {
         return _kt('Workflow');
     }
@@ -1392,6 +1396,75 @@ class KTDocumentWorkflowAction extends KTDocumentAction {
             array('fDocumentId' => $oDocument->getId()));
         }
     }
+    
+    function form_quicktransition() {
+
+        $oForm = new KTForm;
+        $oForm->setOptions(array(
+            'identifier' => 'ktcore.workflow.quicktransition',
+            'label' => _kt("Perform Quick Transition"),
+            'submit_label' => _kt("Perform Transition"),
+            'context' => $this,
+            'action' => 'performquicktransition',
+            'fail_action' => 'quicktransition',
+            'cancel_url' => KTBrowseUtil::getUrlForDocument($this->oDocument),
+        ));
+        $oForm->setWidgets(array(
+            array('ktcore.widgets.reason', array(
+                'label' => _kt("Reason"),
+                'description' => _kt("Specify your reason for performing this action."),
+                'important_description' => _kt("Please bear in mind that you can use a maximum of <strong>250</strong> characters."),
+                'name' => 'reason',
+            )),
+        ));
+        $oForm->setValidators(array(
+            array('ktcore.validators.string', array(
+                'test' => 'reason',
+                'max_length' => 250,
+                'output' => 'reason',
+            )),                     
+        ));
+        
+        return $oForm;
+    }
+
+    function do_quicktransition() {
+        // make sure this gets through.
+        $this->persistParams(array('fTransitionId'));
+        
+        $transition_id = $_REQUEST['fTransitionId'];
+        $oTransition = KTWorkflowTransition::get($transition_id);
+        
+        $oForm = $this->form_quicktransition();
+        return $oForm->renderPage(sprintf(_kt("Perform Transition: %s"), $oTransition->getName()));
+    }
+    
+    function do_performquicktransition() {
+        $oForm = $this->form_quicktransition();
+        $res = $oForm->validate();
+        
+        if (!empty($res['errors'])) {
+            return $oForm->handleError();
+        }    
+        
+        $this->startTransaction();
+        
+        $data = $res['results'];
+        $oTransition = KTWorkflowTransition::get($_REQUEST['fTransitionId']);
+        
+        $res = KTWorkflowUtil::performTransitionOnDocument($oTransition, $this->oDocument, $this->oUser, $data['reason']);
+
+        if(!Permission::userHasDocumentReadPermission($this->oDocument)) {
+            $this->commitTransaction();
+            $_SESSION['KTInfoMessage'][] = _kt('Transition performed') . '. ' . _kt('You no longer have permission to view this document');
+            controllerRedirect('browse', sprintf('fFolderId=%d', $this->oDocument->getFolderId()));
+        } else {
+            $this->commitTransaction();        
+            $_SESSION['KTInfoMessage'][] = _kt('Transition performed');
+            controllerRedirect('viewDocument', sprintf('fDocumentId=%d', $this->oDocument->getId()));
+        }        
+    }
+
 }
 // }}}
  
+<?php
+
+/**
+ *
+ * The contents of this file are subject to the KnowledgeTree Public
+ * License Version 1.1 ("License"); You may not use this file except in
+ * compliance with the License. You may obtain a copy of the License at
+ * http://www.ktdms.com/KPL
+ * 
+ * Software distributed under the License is distributed on an "AS IS"
+ * basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ * 
+ * The Original Code is: KnowledgeTree Open Source
+ * 
+ * The Initial Developer of the Original Code is The Jam Warehouse Software
+ * (Pty) Ltd, trading as KnowledgeTree.
+ * Portions created by The Jam Warehouse Software (Pty) Ltd are Copyright
+ * (C) 2006 The Jam Warehouse Software (Pty) Ltd;
+ * All Rights Reserved.
+ *
+ */
+
+require_once(KT_LIB_DIR . "/actions/documentviewlet.inc.php");
+require_once(KT_LIB_DIR . "/workflow/workflowutil.inc.php");
+
+// {{{ KTDocumentDetailsAction 
+class KTWorkflowViewlet extends KTDocumentViewlet {
+    var $sName = 'ktcore.viewlets.document.workflow';
+
+    function display_viewlet() {
+        $oKTTemplating =& KTTemplating::getSingleton();
+        $oTemplate =& $oKTTemplating->loadTemplate("ktcore/document/viewlets/workflow");
+        if (is_null($oTemplate)) { return ""; }
+        
+        $oWorkflowState = KTWorkflowState::get($this->oDocument->getWorkflowStateId());
+        if (PEAR::isError($oWorkflowState)) {
+            return "";
+        }
+        
+        $aDisplayTransitions = array();
+        $aTransitions = KTWorkflowUtil::getTransitionsForDocumentUser($this->oDocument, $this->oUser);
+        if (empty($aTransitions)) {
+            return "";
+        }
+        
+        foreach ($aTransitions as $oTransition) {
+            $aDisplayTransitions[] = array(
+                'url' => KTUtil::ktLink('action.php', 'ktcore.actions.document.workflow', array("fDocumentId" => $this->oDocument->getId(), "action" => "quicktransition", "fTransitionId" => $oTransition->getId())),
+                'name' => $oTransition->getName(),
+            );
+        }
+        
+        $oTemplate->setData(array(
+            'context' => $this,
+            'transitions' => $aDisplayTransitions,
+            'state_name' => $oWorkflowState->getName(),
+        ));        
+        return $oTemplate->render();
+    }
+}
+// }}}
+
+
+
+?>
@@ -40,12 +40,12 @@ these tasks, use the Request Assistance action.{/i18n}
 {$oFieldset->render($document_data)}
 {/foreach}
  
-{if !empty($viewlets)}
+{if !empty($viewlet_data)}
  
 <!--  Document "Views" -->
 <div id="document-views">
  
-{$sviewlet_data}
+{$viewlet_data}
  
 </div>
 {/if}
+<div class="viewlet download">
+    Download the file! Yay!
+</div>
+<div class="viewlet">
+    <h3>Available Transitions</h3>
+    <p class="descriptiveText">{i18n arg_name=$state_name}The document is currently in state "#name#"{/i18n}</p>
+    <ul>
+    {foreach from=$transitions item=info}
+        <li><a href="{$info.url}">{$info.name}</a></li>
+    {/foreach}
+    </ul>
+</div>