KTS-3169

"Provide some actions for portlets that allow javascript to be called rather than requiring the action framework" Implemented. Committed By: Conrad Vermeulen Reviewed By: Kevin Fourie git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@8263 c91229c3-7414-0410-bfa2-8a42b809f60b

KTS-3169
"Provide some actions for portlets that allow javascript to be called rather than requiring the action framework" Implemented. Committed By: Conrad Vermeulen Reviewed By: Kevin Fourie git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@8263 c91229c3-7414-0410-bfa2-8a42b809f60b
Conrad Vermeulen
1 parent 11d49c4e
Showing 4 changed files with 254 additions and 19 deletions
lib/actions/documentaction.inc.php
lib/actions/folderaction.inc.php
templates/kt3/portlets/actions_portlet.smarty
templates/ktcore/forms/widgets/string.smarty
@@ -5,32 +5,32 @@
  * KnowledgeTree Open Source Edition
  * Document Management Made Simple
  * Copyright (C) 2004 - 2008 The Jam Warehouse Software (Pty) Limited
- * 
+ *
  * This program is free software; you can redistribute it and/or modify it under
  * the terms of the GNU General Public License version 3 as published by the
  * Free Software Foundation.
- * 
+ *
  * 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, see <http://www.gnu.org/licenses/>.
- * 
+ *
  * You can contact The Jam Warehouse Software (Pty) Limited, Unit 1, Tramber Place,
  * Blake Street, Observatory, 7925 South Africa. or email info@knowledgetree.com.
- * 
+ *
  * The interactive user interfaces in modified source and object code versions
  * of this program must display Appropriate Legal Notices, as required under
  * Section 5 of the GNU General Public License version 3.
- * 
+ *
  * In accordance with Section 7(b) of the GNU General Public License version 3,
  * these Appropriate Legal Notices must retain the display of the "Powered by
- * KnowledgeTree" logo and retain the original copyright notice. If the display of the 
+ * KnowledgeTree" logo and retain the original copyright notice. If the display of the
  * logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices
- * must display the words "Powered by KnowledgeTree" and retain the original 
- * copyright notice. 
+ * must display the words "Powered by KnowledgeTree" and retain the original
+ * copyright notice.
  * Contributor( s): ______________________________________
  *
  */
@@ -203,6 +203,121 @@ class KTDocumentAction extends KTStandardDispatcher {
     }
 }
+class JavascriptDocumentAction extends KTDocumentAction
+{
+	/**
+	 * This is an array of js files to be included for this action
+	 *
+	 * @var array
+	 */
+	var $js_paths = array();
+	/**
+	 * This is custom javascript that should be included
+	 *
+	 * @var array
+	 */
+	var $js = array();
+	/**
+	 * Indicates if a custom function should be provided, or if the function is part of an existing js file.
+	 * If true
+	 *
+	 * @var boolean
+	 */
+	var $function_provided_by_action = true;
+
+	/**
+	 * Set the function name if you have a custom name you want to provide.
+	 *
+	 * @var string
+	 */
+	var $function_name = null;
+
+	 function JavascriptDocumentAction($oDocument = null, $oUser = null, $oPlugin = null)
+	 {
+	 	parent::KTDocumentAction($oDocument, $oUser, $oPlugin);
+	 	$this->js_initialise();
+	 }
+
+	function js_initialise()
+	{
+		// this will be overridden
+	}
+
+	function js_include($js)
+	{
+		$this->js[] = $js;
+	}
+
+	function js_include_file($path)
+	{
+		global $AjaxDocumentJSPaths;
+
+		if (!isset($AjaxDocumentJSPaths))
+		{
+			$AjaxDocumentJSPaths = array();
+		}
+
+		if (!in_array($AjaxDocumentJSPaths))
+		{
+			$AjaxDocumentJSPaths[] = $path;
+			$this->js_paths [] = $path;
+		}
+	}
+
+	function customiseInfo($aInfo)
+	{
+		$js = '';
+		foreach($this->js_paths as $path)
+		{
+			$js .= "<script language=\"javascript\" src=\"$path\"></script>\n";
+		}
+
+		$js .= '<script language="javascript">'. "\n";
+		foreach($this->js as $js2)
+		{
+			$js .= $js2 . "\n";
+		}
+
+		$js .= $this->getScript() . '</script>'. "\n";
+
+		$js .= '<div onclick="' . $this->getScriptActivation() . '"><a>' . $this->getDisplayName() . '</a></div>'. "\n";
+
+
+		$aInfo['js'] = $js;
+
+        return $aInfo;
+    }
+
+    function getScript()
+    {
+    	if ($this->function_provided_by_action === false)
+    	{
+    		return '';
+    	}
+    	return "function " . $this->getScriptActivation() . '{'.$this->getFunctionScript().'}';
+    }
+
+	function getFunctionScript()
+	{
+		return 'alert(\''. $this->getDisplayName()  .' not implemented!\');';
+	}
+
+    function getScriptActivation()
+    {
+    	if (!is_null($this->function_name))
+    	{
+    		return $this->function_name;
+    	}
+
+    	global $AjaxDocumentActions;
+    	$class = get_class($this);
+    	return 'js' .  $class. 'Dispatcher()';
+    }
+
+
+
+}
+
 class KTDocumentActionUtil {
     function getDocumentActionInfo($slot = 'documentaction') {
         $oRegistry =& KTActionRegistry::getSingleton();
@@ -5,32 +5,32 @@
  * KnowledgeTree Open Source Edition
  * Document Management Made Simple
  * Copyright (C) 2004 - 2008 The Jam Warehouse Software (Pty) Limited
- * 
+ *
  * This program is free software; you can redistribute it and/or modify it under
  * the terms of the GNU General Public License version 3 as published by the
  * Free Software Foundation.
- * 
+ *
  * 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, see <http://www.gnu.org/licenses/>.
- * 
+ *
  * You can contact The Jam Warehouse Software (Pty) Limited, Unit 1, Tramber Place,
  * Blake Street, Observatory, 7925 South Africa. or email info@knowledgetree.com.
- * 
+ *
  * The interactive user interfaces in modified source and object code versions
  * of this program must display Appropriate Legal Notices, as required under
  * Section 5 of the GNU General Public License version 3.
- * 
+ *
  * In accordance with Section 7(b) of the GNU General Public License version 3,
  * these Appropriate Legal Notices must retain the display of the "Powered by
- * KnowledgeTree" logo and retain the original copyright notice. If the display of the 
+ * KnowledgeTree" logo and retain the original copyright notice. If the display of the
  * logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices
- * must display the words "Powered by KnowledgeTree" and retain the original 
- * copyright notice. 
+ * must display the words "Powered by KnowledgeTree" and retain the original
+ * copyright notice.
  * Contributor( s): ______________________________________
  *
  */
@@ -177,6 +177,122 @@ class KTFolderAction extends KTStandardDispatcher {
 }
+class JavascriptFolderAction extends KTFolderAction
+{
+	/**
+	 * This is an array of js files to be included for this action
+	 *
+	 * @var array
+	 */
+	var $js_paths = array();
+	/**
+	 * This is custom javascript that should be included
+	 *
+	 * @var array
+	 */
+	var $js = array();
+	/**
+	 * Indicates if a custom function should be provided, or if the function is part of an existing js file.
+	 * If true
+	 *
+	 * @var boolean
+	 */
+	var $function_provided_by_action = true;
+
+	/**
+	 * Set the function name if you have a custom name you want to provide.
+	 *
+	 * @var string
+	 */
+	var $function_name = null;
+
+	 function JavascriptFolderAction($oFolder = null, $oUser = null, $oPlugin = null)
+	 {
+	 	parent::KTFolderAction($oFolder, $oUser, $oPlugin);
+	 	$this->js_initialise();
+	 }
+
+	function js_initialise()
+	{
+		// this will be overridden
+	}
+
+	function js_include($js)
+	{
+		$this->js[] = $js;
+	}
+
+	function js_include_file($path)
+	{
+		global $AjaxDocumentJSPaths;
+
+		if (!isset($AjaxDocumentJSPaths))
+		{
+			$AjaxDocumentJSPaths = array();
+		}
+
+		if (!in_array($AjaxDocumentJSPaths))
+		{
+			$AjaxDocumentJSPaths[] = $path;
+			$this->js_paths [] = $path;
+		}
+	}
+
+	function customiseInfo($aInfo)
+	{
+		$js = '';
+		foreach($this->js_paths as $path)
+		{
+			$js .= "<script language=\"javascript\" src=\"$path\"></script>\n";
+		}
+
+		$js .= '<script language="javascript">'. "\n";
+		foreach($this->js as $js2)
+		{
+			$js .= $js2 . "\n";
+		}
+
+		$js .= $this->getScript() . '</script>'. "\n";
+
+		$js .= '<div onclick="' . $this->getScriptActivation() . '"><a>' . $this->getDisplayName() . '</a></div>'. "\n";
+
+
+		$aInfo['js'] = $js;
+
+        return $aInfo;
+    }
+
+    function getScript()
+    {
+    	if ($this->function_provided_by_action === false)
+    	{
+    		return '';
+    	}
+    	return "function " . $this->getScriptActivation() . '{'.$this->getFunctionScript().'}';
+    }
+
+	function getFunctionScript()
+	{
+		return 'alert(\''. $this->getDisplayName()  .' not implemented!\');';
+	}
+
+    function getScriptActivation()
+    {
+    	if (!is_null($this->function_name))
+    	{
+    		return $this->function_name;
+    	}
+
+    	global $AjaxDocumentActions;
+    	$class = get_class($this);
+    	return 'js' .  $class. 'Dispatcher()';
+    }
+
+
+
+}
+
+
 class KTFolderActionUtil {
     function getFolderActions() {
         $oRegistry =& KTActionRegistry::getSingleton();
@@ -2,6 +2,9 @@
 {foreach item=action from=$context->actions }
 {if $action != null}
 <li {if $action.active}class="active"{/if}>
+{if $action.js}
+	{$action.js}
+{else}
 {if ($action.url)}
 <a href="{$action.url}" {if $action.description}title="{$action.description}"{/if}>
 	{$action.name}
@@ -10,5 +13,6 @@
 	{$action.name}
 {/if}</li>
 {/if}
+{/if}
 {/foreach}
 </ul>
-  <input type="text" name="{$name}" {if $has_id}id="{$id}"{/if} {if $has_value}value="{$value|sanitize_input}"{/if}{if ($options.autocomplete === false)}autocomplete="off"{/if}  {if $options.width}size="{$options.width}"{/if} />
+  <input type="text" name="{$name}" {if $has_id}id="{$id}"{/if} {if $has_value}value="{$value|sanitize_input}"{/if}{if ($options.autocomplete === false)}autocomplete="off"{/if}  {if $options.width}size="{$options.width}"{/if} {if $options.onchange}onchange="{$options.onchange}" {/if}/>