DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:function

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
plugin:function [2013-06-01 18:07]
24.7.176.92 [Discussion]
plugin:function [2018-05-31 00:16] (current)
Klap-in [Installation]
Line 6: Line 6:
 email      : tcafferty@glocalfocal.com ​ email      : tcafferty@glocalfocal.com ​
 type       : syntax type       : syntax
-lastupdate : 2012-11-09 +lastupdate : 2013-06-08 
-compatible : Angua+compatible : Angua, Binky, Hrun
 depends ​   :  depends ​   : 
 conflicts ​ :  conflicts ​ : 
Line 22: Line 22:
  
 ===== Installation ===== ===== Installation =====
 +Search and install the plugin using the [[plugin:​extension|Extension Manager]]. Refer to [[:​Plugins]] on how to install plugins manually.
  
-:!: **External requirements:​** None 
- 
-Install the plugin using the [[plugin:​plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:​Plugins]] on how to install plugins manually. 
  
 ===== Examples/​Usage ===== ===== Examples/​Usage =====
  
-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. 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 ===== ===== Syntax =====
  
Line 47: Line 51:
 ===== Configuration and Settings ===== ===== 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.   - 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.   - 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 63:
 === Change Log === === 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 === === Known Bugs and Issues ===
Line 80: Line 88:
 -- [[user>​tom_c]] -- [[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 anonymous ​function declarations. Here is the updated render function in syntax.php and the function declaration in the example helloworld.php ​+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>​ <code syntax.php>​
     function render($mode,​ &​$renderer,​ $indata) {     function render($mode,​ &​$renderer,​ $indata) {
Line 128: Line 136:
 Using a variable to hold the function allows it to be overwritten for each function declaration. ​ Using a variable to hold the function allows it to be overwritten for each function declaration. ​
 -- [[user>​millsdude]] -- [[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]]
plugin/function.1370102846.txt.gz · Last modified: 2013-06-01 18:07 by 24.7.176.92