Lines Matching full:command

4 CommandPluginExtension - Base class for a command of the Command Plugin.
6 Each command is a subclass of CommandPluginExtension.  The name of a subclass
7 must be of the form CommandPluginExtension_<command>, where <command> is the
8 name of the command as it occurs in the syntax, in lowercase letters.  Each
9 subclass must go in its own file, a file with name <command>.php.
11 The behavior of a command may vary according to how the command was embedded
13 block.  When embedding inline, any replacement text that the command produces
19 The class provides two methods.  getCachedData() is a stub that each command
21 the command to be replaced with the string returned by getCachedData() and 
24 The Command Plugin never instantiates this class.  Both methods are static
29 of the command is to allow the user to embed HTML of his/her choosing.
31 See http://www.splitbrain.org/plugin:command for more information.
44      * getCachedData() pre-processes a command to produce data that can be
47      * provides that information.  Usually a command that only produces
57      * parameters that the user provided to the command.  $params is an array
64      * implement the command, or at least to cache any needed arguments.
66      * This method is the Command Plugin analogue of the DokuWiki syntax
70      * @param array $params An array of the command's parameters, indexed by
84      *      command.  Empty string if there was no content.
91      *      null.  If the command is using the default implementation of
93      *      replacement text for the command, unless the method reports an
107      * is generated and to return the replacement text for the command.
112      * when the command produces static text that can be cached in its
113      * entirety.  A command should only override the default implementation
114      * if some aspect of the command is dynamic.
116      * This method is the Command Plugin analogue of the DokuWiki syntax
121      *      returned for the command, which may be null.
125      *      the text, serving as the replacement text for the command.
130      * @return string Replacement text for the command.  The replacement text