banana split

docs/en/programmers/api-functions/api-register-compiler-function.xml

@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision$ -->
+		<sect1 id="api.register.compiler.function">
+			<title>register_compiler_function</title>
+			<funcsynopsis>
+			<funcprototype>
+			<funcdef>void <function>register_compiler_function</function></funcdef>
+				<paramdef>string <parameter>name</parameter></paramdef>
+				<paramdef>mixed <parameter>impl</parameter></paramdef>
+				<paramdef>bool <parameter>cacheable</parameter></paramdef>
+			</funcprototype>
+			</funcsynopsis>
+			<para>
+                Use this to dynamically register a compiler function plugin.
+                Pass in the compiler function name, followed by the PHP
+                function that implements it.
+			</para>
+			<para>
+                The php-function callback <parameter>impl</parameter> can be either (a) a string
+		containing the function name or (b) an array of the form
+		<literal>array(&amp;$object, $method)</literal> with
+		<literal>&amp;$object</literal> being a reference to an
+		object and <literal>$method</literal> being a string
+		containing the mehod-name or (c) an array of the form
+		<literal>array(&amp;$class, $method)</literal> with
+		<literal>$class</literal> being a classname and
+		<literal>$method</literal> being a class method of that
+		class.
+			</para>
+			<para>
+                <parameter>$cacheable</parameter> can be omitted in
+                most cases. See <link linkend="caching.cacheable">Controlling
+                Cacheability of Plugins' Output</link> on how to it properly.
+			</para>
+</sect1>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->