cvs: peardoc /en/package/html/html-template-flexy configuration.xml

From: Date: Thu, 07 Jul 2005 08:58:27 +0000
Subject: cvs: peardoc /en/package/html/html-template-flexy configuration.xml
Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-6469@lists.php.net to get a copy of this message
alan_k Thu Jul 7 04:58:27 2005 EDT Modified files: /peardoc/en/package/html/html-template-flexy configuration.xml Log: fully list all the current configuration options - wow livedocs makes a world of difference to doing this!

http://cvs.php.net/diff.php/peardoc/en/package/html/html-template-flexy/configuration.xml?r1=1.7&r2=1.8&ty=u Index: peardoc/en/package/html/html-template-flexy/configuration.xml diff -u peardoc/en/package/html/html-template-flexy/configuration.xml:1.7 peardoc/en/package/html/html-template-flexy/configuration.xml:1.8 --- peardoc/en/package/html/html-template-flexy/configuration.xml:1.7 Tue Oct 14 18:54:25 2003 +++ peardoc/en/package/html/html-template-flexy/configuration.xml Thu Jul 7 04:58:25 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- @@ -192,6 +192,293 @@ </para> </listitem> </varlistentry> + + + + + <varlistentry> + <term> + <parameter>compiler</parameter> + <type>string</type> + </term> + <listitem> + <para> + Default is 'Flexy' - The Flexy Tokenizer Driver engine. Other engines available are + regex (similar to Xipe's engine), Raw (For plain PHP files with no replacement or compiling) + and Standard (depreciated). + You can use this field to load your own engines, either based + Off the core code, or totally seperate.. + + </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term> + <parameter>multiSource</parameter> + <type>boolean</type> + </term> + <listitem> + <para> + Default is false - Allow the same template to exist in multiple places + (eg. if you have theme's and want to fall back to a default template + if the themed version doesnt exist.) + + </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term> + <parameter>templateDirOrder</parameter> + <type>string</type> + </term> + <listitem> + <para> + Default is '' - by default, the first matched template is used, + if you have multiple paths, and want the last in the list to be used, + then set this to 'reverse' + + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <parameter>filters</parameter> + <type>array|string</type> + </term> + <listitem> + <para> + an array or comma seperated string of filters ONLY USED BY THE Regex backend, + available filters are: BodyOnly (strip everything before and after body tag), + Mail (add an extra line break after php tags.), + Php (removes php code, not very reliably), + SimpleTags (variable, method etc. replacement), + XML (replace XML opening tag with echos.) + </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term> + <parameter>nonHTML</parameter> + <type>boolean</type> + </term> + <listitem> + <para> + default is false - if you use the Flexy compiler, it turns off parsing of HTML, + (not heavily tested) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <parameter>allowPHP</parameter> + <type>boolean|string</type> + </term> + <listitem> + <para> + default is false - allows php code in templates, normally off to help you + reduce the chance of you shooting your self in the foot by forgetting to + escape output.. (can be usefull for complex looping), but not normally recommended. + setting to true, enables PHP code, setting to 'delete' removes php code. (although it + doesnt prevent XSS attacks, so it is only suited to trusted users) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <parameter>flexyIgnore</parameter> + <type>boolean</type> + </term> + <listitem> + <para> + default is false - setting to true, will turn off the conversion of html form + elements into HTML_Template_Flexy_Element's + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <parameter>numberFormat</parameter> + <type>string</type> + </term> + <listitem> + <para> + default is &quot;,2,'.',','&quot; - this is the piece of code that is appended + to the output engine when using the :n modifier, eg. {xxxx:n} is replaced with + number_format($t-&gt;xxxx,2,'.',','); seen the php manual page for number_format + the default output would be: 1,200.00 + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <parameter>url_rewrite</parameter> + <type>string</type> + </term> + <listitem> + <para> + when compiling the template flexy can rewrite + &lt;img src, + &lt;script src, + &lt;a href + and xul stylesheet urls. The format is + &quot;match/original:new/url, match/another/original:new/url&quot; + each combo is seperated by a comma, and the colon seperates the pair. + This helps previewing templates without using the engine. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <parameter>compileToString</parameter> + <type>boolean</type> + </term> + <listitem> + <para> + default false - if set tot try, the compile will return a string of the + compiled template, rather than writing it to the cache file. eg. + {object._myvar} + </para> + </listitem> + </varlistentry> + + + + <varlistentry> + <term> + <parameter>privates</parameter> + <type>boolean</type> + </term> + <listitem> + <para> + default false - if set to true, you can access variables prefixed with + an underscore (normally private in PEAR's coding standards) + eg. {someobject._myprivatevar} and {_myprivate} + + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <parameter>globals</parameter> + <type>boolean</type> + </term> + <listitem> + <para> + default false - if set to true, you can access php's globals and superglobals, + eg. {_POST[myvar]}, {GLOBALS[somevalue]} + + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <parameter>globalfunctions</parameter> + <type>boolean</type> + </term> + <listitem> + <para> + default false - if set to true, you can access any native php function using the GLOBALS. + prefix eg. {GLOBALS.date(#d/m/Y#)} obviously you should trust your template authors, + as they can easily run exec() if this is enabled. + </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term> + <parameter>locale</parameter> + <type>string</type> + </term> + <listitem> + <para> + default 'en' - either used to search for language specific templates + with {filename}.{locale}.{extension} or in conjunction with the Translation2 + language translation toolkit, to set the language used to + translate templates to at compile time. + + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <parameter>Translation2</parameter> + <type>mixed</type> + </term> + <listitem> + <para> + default false - you can set this to an array or an existing Translation2 object + eg. Translation2 =&gt; array('driver'=&gt;'dataobjectsimple', options=&gt;array())); + + + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <parameter>strict</parameter> + <type>boolean</type> + </term> + <listitem> + <para> + default false - By default warnings about undefined variabes are hidden, + this turns on all PHP warnings during the outputObject calls. Can be usefull + for finding bugs hidden by method callbacks. + </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term> + <parameter>fatalError</parameter> + <type>int</type> + </term> + <listitem> + <para> + default constant HTML_TEMPLATE_FLEXY_ERROR_DIE - this determines the behaviour + when compiling a template fails, normally flexy will die and report the error to + the screen, you can change this to HTML_TEMPLATE_FLEXY_ERROR_RETURN, if you want + to recieve a PEAR_Error object from compile(). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <parameter>plugins</parameter> + <type>string|array</type> + </term> + <listitem> + <para> + loads plugin classes, (by default from the Plugin folder), these can be used either + via {plugin.nameofmethod} or as a modifier {outputstring:dateformat}, default formats + are normally collected via configuration options plugin.dateformat, + plugin.numberformat.decimals, plugin.numberformat.point, plugin.numberformat.thousands + </para> + </listitem> + </varlistentry> + + + + + </variablelist> </refsect1>
« previous php.pear.doc (#6469) next »