Differences

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

--- plugin:function [2013-06-01 17:19] – Aleksandr
+++ plugin:function [2014-12-19 14:29] – 2001:660:4701:2010:76d0:2bff:fe2a:8bbf
@@ Line 6: / Line 6: @@
 email      : tcafferty@glocalfocal.com
 type       : syntax
-lastupdate : 2012-11-09
+lastupdate : 2013-06-08
-compatible : Angua
+compatible : Angua, Binky, Hrun
 depends    :
 conflicts  :
@@ Line 29: / Line 29: @@
 ===== Examples/Usage =====
-A sample function is included called ''/functions/helloWorld.php''. To use add the following plugin syntax to a wiki page. No configuration changes are needed to run the sample.
+Two sample functions are included called ''/functions/helloWorld.php'' and ''/functions/anotherhelloWorld.php''. To use add the following plugin syntax to a wiki page. No configuration changes are needed to run the sample.
-<code><function=file1?0=That's&1=All&2=Folks!&num=3></code>
+<code>
-The example passes 4 parameters to the invoked function.
+<function=file2?0=That's&1=All&2=Folks!&num=3>
+<function=file3>
+<function=file2?0=That's&1=All&2=Folks!&num=3>
+</code>
+The example passes 4 parameters to the invoked function, invokes a different function with no parameters, and then calls the first function again.
-Parameters are passed as strings. The example shows how the invoked function typecasts the last parameter to be used as an integer.
+Parameters are passed as array elements. The example shows how the invoked function typecasts the last parameter to be used as an integer.
 Parameters are not required. The simplest usage is to invoke a function with no parameters.
+Examples can be seen at [[http://clean.glocalfocal.com/doku.php?id=start|Plugin Examples Site]]
 ===== Syntax =====
@@ Line 47: / Line 53: @@
 ===== Configuration and Settings =====
-  - Add a file containing the php function into the /functions folder. The main function must be called 'run'.
+  - Add a file containing the php function into the /functions folder. The main function must be called defined as
+      <code>$thisfunction = function($params) {
+                .....
+            };
+       </code>
   - Add a configuration parameter in /conf/default.php that contains a name to identify the function file and set it equal to the name of the file. No path information is required.
   - You can add a function description in /lang/../settings.php. This will show up in the admin configuration panel for the plugin.
@@ Line 55: / Line 65: @@
 === Change Log ===
-{{rss>http://github.com/feeds/TomCafferty/commits/plugin-function/master date}}
+{{rss>https://github.com/TomCafferty/plugin-function/commits/master.atom date}}
 === Known Bugs and Issues ===
@@ Line 79: / Line 89: @@
 Best regards
 -- [[user>tom_c]]
+I noticed a problem when I was using two different functions on a single page. The run() declaration was already defined when it hit the second function call. I was able to solve this by using variable function declarations. Here is the updated render function in syntax.php and the function declaration in the example helloworld.php
+<code syntax.php>
+    function render($mode, &$renderer, $indata) {
+        global $conf;
+        if($mode == 'xhtml'){
+          list($state, $data) = $indata;
+          switch ($state) {
+            case DOKU_LEXER_SPECIAL :
+              preg_match("#^<function=(.+)>$#", $data, $matches);
+              $func = $matches[1];
+              $a = explode('?', $func);
+              $func = $a[0];
+              if (!empty($a[1])) { parse_str($a[1], $params); }
+              else { $params = ''; }
+              if(preg_match("#^[a-z0-9\-_ \./]+$#i", $func)) {
+                    $renderer->info['cache'] = FALSE;
+                    $filename = DOKU_PLUGIN . 'function/functions/' . $this->getConf($func);
+                    include ($filename);
+                    $renderer->doc .= $thisfunction($params);
+              }
+              else
+                    $renderer->doc .= $renderer->_xmlEntities($data);
+              break;
+          }
+          return true;
+        }
+        // unsupported $mode
+        return false;
+    }
+</code>
+<code helloworld.php>
+$thisfunction = function($params) {
+    // Create output data
+    $dataout='<p class="cellGreen">Hello World!</p>';
+    $num=(int)$params['num'];
+    $dataout .= ' The '.($num+1).' parameters were the number '.$num .' preceded by <br />';
+    foreach ($params AS $key=>$val){
+        if ($val != $num) $dataout.=$val.'<br />';
+    }
+	return $dataout;
+};
+</code>
+Using a variable to hold the function allows it to be overwritten for each function declaration.
+-- [[user>millsdude]]
+Millsdude, thanks for this update! It works real nice. I incorporated it into the release.
+-- [[user>tom_c]]
+It may be worth noting that, although DokuWiki itself [[:requirements|requires only PHP version 5.2]], the function plugin seems to require a more recent version.  The plugin makes use of [[http://php.net/manual/en/functions.anonymous.php|anonymous function variable assignment]], a capability introduced in PHP version 5.3. -- [[user>areeves]]