root/tags/fster-live-20070823/README

Revision 24, 4.5 kB (checked in by george, 7 years ago)

readme file to doc functions

Line 
1 INI Settings
2 ==============================================
3
4     Option                  Description
5     ------------------      --------------------------------------------------
6     fastxsl.shmpath         
7                             The path to key your shared memory segment off of.
8                             Depending on which mm implementation you use, this
9                             path may or may not need to be creatable.
10                             (DEFAULT: "/tmp/fastxsl_mem")
11
12     fastxsl.nostat         
13                             Whether or not to check xsl files to determine
14                             if they are changed.  If this is set to '1',
15                             then xsl changes will not be picked up until
16                             the server is restarted.
17                             (DEFAULT: 0)
18
19     fastxsl.memalloc       
20                             The amount of shared memory to allocate to
21                             FastXSL for caching stylesheets.  If this is
22                             set to 0, FastXSL will allocate as much memory
23                             as libmm will permit it to.
24                             (DEFAULT: 0)
25  
26     fastxsl.register_functions
27                             Whether or not to register the PHP extension
28                             namespace and allow users to use PHP functions
29                             as XSLT extension functions.
30                             (DEFAULT: 0)
31
32
33 EXPORTED FUNCTIONS
34 ==================
35
36 float fastxsl_version()
37                             Returns the version number of the FastXSL library.
38
39 resource fastxsl_xml_parsefile(string filename)
40                             Parses the filename in question and returns it
41                             as a FastXSL XML document resource.
42
43 resource fastxsl_xml_parsestring(string str)
44                             Parses the string in question and returns it
45                             as a FastXSL XML document resource.
46
47 resource fastxsl_shmcache_transform(string xsl, resource xmldoc [, array params])
48                             Apply the XSL stylesheet given by 'xsl' to the xml
49                             document resource given by xmldoc, with optional
50                             XSL params.  The compiled stylesheet will be
51                             cached in shared memory.  Returns a FastXSL
52                             result resource.
53
54 resource fastxsl_prmcache_transform(string xsl, resource xmldoc [, array params])
55                             Apply the XSL stylesheet given by 'xsl' to the xml
56                             document resource given by xmldoc, with optional
57                             XSL params.  The compiled stylesheet will be
58                             cached in process-local memory.  Because of the
59                             large amount of memory libxslt uses, use of
60                             the prm functions is discouraged.  Returns a
61                             FastXSL result resource.
62
63 resource fastxsl_nocache_transform(string xsl, resource xmldoc [, array params])
64                             Apply the XSL stylesheet given by 'xsl' to the xml
65                             document resource given by xmldoc, with optional
66                             XSL params.  The compiled stylesheet will be
67                             not be cached.  Returns a FastXSL result resource.
68
69 string fastxsl_shmcache_tostring(string xsl, resource fastxsl_result)
70                            Takes a stylesheet and a result resource and
71                            returns the transformed document.  This must
72                            be used with resources created with
73                            fastxsl_shmcache_transform().
74
75 string fastxsl_prmcache_tostring(string xsl, resource fastxsl_result)
76                            Takes a stylesheet and a result resource and
77                            returns the transformed document.  This must
78                            be used with resources created with
79                            fastxsl_prmcache_transform().
80
81 string fastxsl_nocache_tostring(string xsl, resource fastxsl_result)
82                            Takes a stylesheet and a result resource and
83                            returns the transformed document.  This must
84                            be used with resources created with
85                            fastxsl_nocache_transform().
86                            
87 array fastxsl_shmcache_getstatistics()
88                            Returns an array of statistics regarding what
89                            data is cached and how much space it is consuming.                           
Note: See TracBrowser for help on using the browser.