| [ PHPXref.com ] | [ Generated: Sun Jul 20 20:37:06 2008 ] | [ TextilePHP 2.0.8 ] |
| [ Index ] [ Variables ] [ Functions ] [ Classes ] [ Constants ] [ Statistics ] | ||
[Summary view] [Print] [Text view]
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3 <title>TextilePHP: Textile class Reference</title> 4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 5 </head><body> 6 <!-- Generated by Doxygen 1.3.7 --> 7 <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a></div> 8 <h1>Textile Class Reference</h1>Class wrapper for the Textile functionality. 9 <a href="#_details">More...</a> 10 <p> 11 <p>Inheritance diagram for Textile: 12 <p><center><img src="classTextile.png" usemap="#Textile_map" border="0" alt=""></center> 13 <map name="Textile_map"> 14 <area href="classMTLikeTextile.html" alt="MTLikeTextile" shape="rect" coords="0,56,89,80"> 15 </map> 16 <a href="classTextile-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> 17 <tr><td></td></tr> 18 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> 19 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#a0">Textile</a> ($options=array())</td></tr> 20 21 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#a1">set</a> ($opt, $value=NULL)</td></tr> 22 23 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#a2">get</a> ($opt)</td></tr> 24 25 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#a3">disable_html</a> ($disable_html=NULL)</td></tr> 26 27 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#a4">head_offset</a> ($head_offset=NULL)</td></tr> 28 29 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#a5">flavor</a> ($flavor=NULL)</td></tr> 30 31 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#a6">css</a> ($css=NULL)</td></tr> 32 33 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#a7">charset</a> ($charset=NULL)</td></tr> 34 35 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#a8">docroot</a> ($docroot=NULL)</td></tr> 36 37 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#a9">trim_spaces</a> ($trim_spaces=NULL)</td></tr> 38 39 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#a10">filter_param</a> ($filter_param=NULL)</td></tr> 40 41 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#a11">preserve_spaces</a> ($preserve_spaces=NULL)</td></tr> 42 43 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#a12">filters</a> ($filters=NULL)</td></tr> 44 45 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#a13">char_encoding</a> ($char_encoding=NULL)</td></tr> 46 47 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#a14">handle_quotes</a> ($do_quotes=NULL)</td></tr> 48 49 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#a15">process</a> ($str)</td></tr> 50 51 <tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr> 52 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#e0">version</a> ()</td></tr> 53 54 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> 55 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#o0">$Have_Entities</a> = 1</td></tr> 56 57 <tr><td colspan=2><br><h2>Private Member Functions</h2></td></tr> 58 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d0">_create_re</a> ()</td></tr> 59 60 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d1">format_paragraph</a> ($args)</td></tr> 61 62 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d2">format_inline</a> ($args)</td></tr> 63 64 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d3">format_macro</a> ($attrs)</td></tr> 65 66 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d4">format_cite</a> ($args)</td></tr> 67 68 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d5">format_code</a> ($args)</td></tr> 69 70 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d6">format_classstyle</a> ($clsty=NULL, $class=NULL, $style=NULL)</td></tr> 71 72 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d7">format_tag</a> ($args)</td></tr> 73 74 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d8">format_deflist</a> ($args)</td></tr> 75 76 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d9">add_term</a> ($dt, $dd)</td></tr> 77 78 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d10">format_list</a> ($args)</td></tr> 79 80 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d11">format_block</a> ($args)</td></tr> 81 82 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d12">format_link</a> ($args)</td></tr> 83 84 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d13">format_url</a> ($args)</td></tr> 85 86 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d14">format_span</a> ($args)</td></tr> 87 88 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d15">format_image</a> ($args)</td></tr> 89 90 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d16">format_table</a> ($args)</td></tr> 91 92 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d17">apply_filters</a> ($args)</td></tr> 93 94 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d18">encode_html</a> ($html, $can_double_encode=FALSE)</td></tr> 95 96 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d19">decode_html</a> ($html)</td></tr> 97 98 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d20">encode_html_basic</a> ($html, $can_double_encode=FALSE)</td></tr> 99 100 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d21">image_size</a> ($file)</td></tr> 101 102 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d22">encode_url</a> ($str)</td></tr> 103 104 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d23">mail_encode</a> ($addr)</td></tr> 105 106 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d24">process_quotes</a> ($str)</td></tr> 107 108 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d25">default_macros</a> ()</td></tr> 109 110 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d26">_css_defaults</a> ()</td></tr> 111 112 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d27">_halign</a> ($align)</td></tr> 113 114 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d28">_valign</a> ($align)</td></tr> 115 116 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d29">_imgalign</a> ($align)</td></tr> 117 118 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d30">_strip_borders</a> (&$pre, &$post)</td></tr> 119 120 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d31">_repl</a> (&$array, $str)</td></tr> 121 122 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d32">_tokenize</a> ($str)</td></tr> 123 124 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#d33">_cb</a> ($function)</td></tr> 125 126 <tr><td colspan=2><br><h2>Static Private Member Functions</h2></td></tr> 127 <tr><td class="memItemLeft" nowrap align=right valign=top>& </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#h0">_current_store</a> (&$new)</td></tr> 128 129 <tr><td class="memItemLeft" nowrap align=right valign=top>& </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#h1">_current</a> ()</td></tr> 130 131 <tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> 132 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#r0">$options</a> = array()</td></tr> 133 134 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#r1">$urlre</a></td></tr> 135 136 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#r2">$punct</a></td></tr> 137 138 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#r3">$valignre</a></td></tr> 139 140 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#r4">$tblalignre</a></td></tr> 141 142 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#r5">$halignre</a></td></tr> 143 144 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#r6">$alignre</a></td></tr> 145 146 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#r7">$imgalignre</a></td></tr> 147 148 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#r8">$clstypadre</a></td></tr> 149 150 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#r9">$clstyre</a></td></tr> 151 152 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#r10">$clstyfiltre</a></td></tr> 153 154 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#r11">$codere</a></td></tr> 155 156 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#r12">$blocktags</a></td></tr> 157 158 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#r13">$links</a> = array()</td></tr> 159 160 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#r14">$repl</a> = array()</td></tr> 161 162 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTextile.html#r15">$tmp</a> = array()</td></tr> 163 164 </table> 165 <hr><a name="_details"></a><h2>Detailed Description</h2> 166 Class wrapper for the Textile functionality. 167 <p> 168 The Textile class serves as a wrapper for all Textile functionality. It is not inherently necessary that Textile be a class; however, this is as close as one can get to a namespace in PHP. Wrapping the functionality in a class prevents name collisions and dirtying of the global namespace. The Textile class uses no global variables and will not have any side-effects on other code. 169 <p> 170 171 <p> 172 Definition at line <a class="el" href="Textile_8php-source.html#l00030">30</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>.<hr><h2>Constructor & Destructor Documentation</h2> 173 <a class="anchor" name="a0" doxytag="Textile::Textile" ></a><p> 174 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> 175 <tr> 176 <td class="mdRow"> 177 <table cellpadding="0" cellspacing="0" border="0"> 178 <tr> 179 <td class="md" nowrap valign="top"> Textile::Textile </td> 180 <td class="md" valign="top">( </td> 181 <td class="md" nowrap valign="top">$ </td> 182 <td class="mdname1" valign="top" nowrap> <em>options</em> = <code>array()</code> </td> 183 <td class="md" valign="top"> ) </td> 184 <td class="md" nowrap></td> 185 </tr> 186 </table> 187 </td> 188 </tr> 189 </table> 190 <table cellspacing=5 cellpadding=0 border=0> 191 <tr> 192 <td> 193 194 </td> 195 <td> 196 197 <p> 198 Instantiates a new Textile object. Optional options can be passed to initialize the object. Attributes for the options key are the same as the get/set method names documented here.<p> 199 <dl compact><dt><b>Parameters:</b></dt><dd> 200 <table border="0" cellspacing="2" cellpadding="0"> 201 <tr><td></td><td valign=top><em>$options</em> </td><td>The <code>array</code> specifying the options to use for this object. </td></tr> 202 </table> 203 </dl> 204 205 <p> 206 Definition at line <a class="el" href="Textile_8php-source.html#l00186">186</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>. 207 <p> 208 References <a class="el" href="Textile_8php-source.html#l00037">$options</a>, <a class="el" href="Textile_8php-source.html#l00599">_create_re()</a>, <a class="el" href="Textile_8php-source.html#l00558">char_encoding()</a>, <a class="el" href="Textile_8php-source.html#l00433">charset()</a>, <a class="el" href="Textile_8php-source.html#l00404">css()</a>, <a class="el" href="Textile_8php-source.html#l02807">default_macros()</a>, <a class="el" href="Textile_8php-source.html#l00537">filters()</a>, <a class="el" href="Textile_8php-source.html#l00313">flavor()</a>, <a class="el" href="Textile_8php-source.html#l00290">head_offset()</a>, <a class="el" href="Textile_8php-source.html#l00518">preserve_spaces()</a>, and <a class="el" href="Textile_8php-source.html#l00478">trim_spaces()</a>. </td> 209 </tr> 210 </table> 211 <hr><h2>Member Function Documentation</h2> 212 <a class="anchor" name="d33" doxytag="Textile::_cb" ></a><p> 213 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> 214 <tr> 215 <td class="mdRow"> 216 <table cellpadding="0" cellspacing="0" border="0"> 217 <tr> 218 <td class="md" nowrap valign="top"> Textile::_cb </td> 219 <td class="md" valign="top">( </td> 220 <td class="md" nowrap valign="top">$ </td> 221 <td class="mdname1" valign="top" nowrap> <em>function</em> </td> 222 <td class="md" valign="top"> ) </td> 223 <td class="md" nowrap><code> [private]</code></td> 224 </tr> 225 </table> 226 </td> 227 </tr> 228 </table> 229 <table cellspacing=5 cellpadding=0 border=0> 230 <tr> 231 <td> 232 233 </td> 234 <td> 235 236 <p> 237 Creates a custom callback function from the provided PHP code. The result is used as the callback in <code>preg_replace_callback</code> calls. *JHR*<p> 238 <dl compact><dt><b>Parameters:</b></dt><dd> 239 <table border="0" cellspacing="2" cellpadding="0"> 240 <tr><td></td><td valign=top><em>$function</em> </td><td>A <code>string</code> specifying the PHP code for the function body.</td></tr> 241 </table> 242 </dl> 243 <dl compact><dt><b>Returns:</b></dt><dd>A <code>function</code> to be used for the callback. </dd></dl> 244 245 <p> 246 Definition at line <a class="el" href="Textile_8php-source.html#l03243">3243</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>. 247 <p> 248 References <a class="el" href="Textile_8php-source.html#l03283">_current()</a>, and <a class="el" href="Textile_8php-source.html#l03263">_current_store()</a>. </td> 249 </tr> 250 </table> 251 <a class="anchor" name="d0" doxytag="Textile::_create_re" ></a><p> 252 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> 253 <tr> 254 <td class="mdRow"> 255 <table cellpadding="0" cellspacing="0" border="0"> 256 <tr> 257 <td class="md" nowrap valign="top"> Textile::_create_re </td> 258 <td class="md" valign="top">( </td> 259 <td class="mdname1" valign="top" nowrap> </td> 260 <td class="md" valign="top"> ) </td> 261 <td class="md" nowrap><code> [private]</code></td> 262 </tr> 263 </table> 264 </td> 265 </tr> 266 </table> 267 <table cellspacing=5 cellpadding=0 border=0> 268 <tr> 269 <td> 270 271 </td> 272 <td> 273 274 <p> 275 Creates the class variable regular expression patterns used by Textile. They are not initialized in the declaration, because some rely on the others, requiring a <code>$this</code> reference.<p> 276 PHP does not have the Perl qr operator to quote or precompile patterns, so to avoid escaping and matching problems, all patterns must use the same delimiter; this implementation uses {}. Every use of these patterns within this class has been changed to use these delimiters. *JHR* 277 <p> 278 Definition at line <a class="el" href="Textile_8php-source.html#l00599">599</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>. 279 <p> 280 Referenced by <a class="el" href="Textile_8php-source.html#l00186">Textile()</a>. </td> 281 </tr> 282 </table> 283 <a class="anchor" name="d26" doxytag="Textile::_css_defaults" ></a><p> 284 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> 285 <tr> 286 <td class="mdRow"> 287 <table cellpadding="0" cellspacing="0" border="0"> 288 <tr> 289 <td class="md" nowrap valign="top"> Textile::_css_defaults </td> 290 <td class="md" valign="top">( </td> 291 <td class="mdname1" valign="top" nowrap> </td> 292 <td class="md" valign="top"> ) </td> 293 <td class="md" nowrap><code> [private]</code></td> 294 </tr> 295 </table> 296 </td> 297 </tr> 298 </table> 299 <table cellspacing=5 cellpadding=0 border=0> 300 <tr> 301 <td> 302 303 </td> 304 <td> 305 306 <p> 307 Sets the default CSS names for CSS controlled markup. This is an internal function that should not be called directly. 308 <p> 309 Definition at line <a class="el" href="Textile_8php-source.html#l02980">2980</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>. 310 <p> 311 Referenced by <a class="el" href="Textile_8php-source.html#l00404">css()</a>, and <a class="el" href="Textile_8php-source.html#l00313">flavor()</a>. </td> 312 </tr> 313 </table> 314 <a class="anchor" name="h1" doxytag="Textile::_current" ></a><p> 315 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> 316 <tr> 317 <td class="mdRow"> 318 <table cellpadding="0" cellspacing="0" border="0"> 319 <tr> 320 <td class="md" nowrap valign="top"> & Textile::_current </td> 321 <td class="md" valign="top">( </td> 322 <td class="mdname1" valign="top" nowrap> </td> 323 <td class="md" valign="top"> ) </td> 324 <td class="md" nowrap><code> [static, private]</code></td> 325 </tr> 326 </table> 327 </td> 328 </tr> 329 </table> 330 <table cellspacing=5 cellpadding=0 border=0> 331 <tr> 332 <td> 333 334 </td> 335 <td> 336 337 <p> 338 Returns the "current" Textile object. This is used within anonymous callback functions which cannot have the scope of a specific object. *JHR*<p> 339 <dl compact><dt><b>Returns:</b></dt><dd>An <code>object</code> reference to the current Textile object. </dd></dl> 340 341 <p> 342 Definition at line <a class="el" href="Textile_8php-source.html#l03283">3283</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>. 343 <p> 344 References <a class="el" href="Textile_8php-source.html#l03263">_current_store()</a>. 345 <p> 346 Referenced by <a class="el" href="Textile_8php-source.html#l03243">_cb()</a>. </td> 347 </tr> 348 </table> 349 <a class="anchor" name="h0" doxytag="Textile::_current_store" ></a><p> 350 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> 351 <tr> 352 <td class="mdRow"> 353 <table cellpadding="0" cellspacing="0" border="0"> 354 <tr> 355 <td class="md" nowrap valign="top"> & Textile::_current_store </td> 356 <td class="md" valign="top">( </td> 357 <td class="md" nowrap valign="top">&$ </td> 358 <td class="mdname1" valign="top" nowrap> <em>new</em> </td> 359 <td class="md" valign="top"> ) </td> 360 <td class="md" nowrap><code> [static, private]</code></td> 361 </tr> 362 </table> 363 </td> 364 </tr> 365 </table> 366 <table cellspacing=5 cellpadding=0 border=0> 367 <tr> 368 <td> 369 370 </td> 371 <td> 372 373 <p> 374 Stores a static variable for the Textile class. This helper function is used by <code>_current</code> to simulate a static class variable in PHP. *JHR*<p> 375 <dl compact><dt><b>Parameters:</b></dt><dd> 376 <table border="0" cellspacing="2" cellpadding="0"> 377 <tr><td></td><td valign=top><em>$new</em> </td><td>If a non-<code>NULL</code> object reference, the Textile object to be set as the current object.</td></tr> 378 </table> 379 </dl> 380 <dl compact><dt><b>Returns:</b></dt><dd>The <code>array</code> containing a reference to the current Textile object at index 0. An array is used because PHP does not allow static variables to be references. </dd></dl> 381 382 <p> 383 Definition at line <a class="el" href="Textile_8php-source.html#l03263">3263</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>. 384 <p> 385 Referenced by <a class="el" href="Textile_8php-source.html#l03243">_cb()</a>, and <a class="el" href="Textile_8php-source.html#l03283">_current()</a>. </td> 386 </tr> 387 </table> 388 <a class="anchor" name="d27" doxytag="Textile::_halign" ></a><p> 389 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> 390 <tr> 391 <td class="mdRow"> 392 <table cellpadding="0" cellspacing="0" border="0"> 393 <tr> 394 <td class="md" nowrap valign="top"> Textile::_halign </td> 395 <td class="md" valign="top">( </td> 396 <td class="md" nowrap valign="top">$ </td> 397 <td class="mdname1" valign="top" nowrap> <em>align</em> </td> 398 <td class="md" valign="top"> ) </td> 399 <td class="md" nowrap><code> [private]</code></td> 400 </tr> 401 </table> 402 </td> 403 </tr> 404 </table> 405 <table cellspacing=5 cellpadding=0 border=0> 406 <tr> 407 <td> 408 409 </td> 410 <td> 411 412 <p> 413 Returns the alignment keyword depending on the symbol passed.<p> 414 <ul> 415 <li> 416 <b><code><></code></b><p> 417 becomes 'justify'<p> 418 </li> 419 <li> 420 <b><code><</code></b><p> 421 becomes 'left'<p> 422 </li> 423 <li> 424 <b><code>></code></b><p> 425 becomes 'right'<p> 426 </li> 427 <li> 428 <b><code>=</code></b><p> 429 becomes 'center'<p> 430 </li> 431 </ul> 432 <p> 433 <dl compact><dt><b>Parameters:</b></dt><dd> 434 <table border="0" cellspacing="2" cellpadding="0"> 435 <tr><td></td><td valign=top><em>$align</em> </td><td>A <code>string</code> specifying the alignment code.</td></tr> 436 </table> 437 </dl> 438 <dl compact><dt><b>Returns:</b></dt><dd>A <code>string</code> containing the alignment text. </dd></dl> 439 440 <p> 441 Definition at line <a class="el" href="Textile_8php-source.html#l03025">3025</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>. </td> 442 </tr> 443 </table> 444 <a class="anchor" name="d29" doxytag="Textile::_imgalign" ></a><p> 445 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> 446 <tr> 447 <td class="mdRow"> 448 <table cellpadding="0" cellspacing="0" border="0"> 449 <tr> 450 <td class="md" nowrap valign="top"> Textile::_imgalign </td> 451 <td class="md" valign="top">( </td> 452 <td class="md" nowrap valign="top">$ </td> 453 <td class="mdname1" valign="top" nowrap> <em>align</em> </td> 454 <td class="md" valign="top"> ) </td> 455 <td class="md" nowrap><code> [private]</code></td> 456 </tr> 457 </table> 458 </td> 459 </tr> 460 </table> 461 <table cellspacing=5 cellpadding=0 border=0> 462 <tr> 463 <td> 464 465 </td> 466 <td> 467 468 <p> 469 Returns the alignment keyword depending on the symbol passed. The following alignment symbols are recognized, and given preference in the order listed:<p> 470 <ul> 471 <li> 472 <b><code>^</code></b><p> 473 becomes 'top'<p> 474 </li> 475 <li> 476 <b><code>~</code></b><p> 477 becomes 'bottom'<p> 478 </li> 479 <li> 480 <b><code>-</code></b><p> 481 becomes 'middle'<p> 482 </li> 483 <li> 484 <b><code><</code></b><p> 485 becomes 'left'<p> 486 </li> 487 <li> 488 <b><code>></code></b><p> 489 becomes 'right'<p> 490 </li> 491 </ul> 492 <p> 493 <dl compact><dt><b>Parameters:</b></dt><dd> 494 <table border="0" cellspacing="2" cellpadding="0"> 495 <tr><td></td><td valign=top><em>$align</em> </td><td>A <code>string</code> containing the alignment code.</td></tr> 496 </table> 497 </dl> 498 <dl compact><dt><b>Returns:</b></dt><dd>A <code>string</code> containing the alignment text. </dd></dl> 499 500 <p> 501 Definition at line <a class="el" href="Textile_8php-source.html#l03109">3109</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>. </td> 502 </tr> 503 </table> 504 <a class="anchor" name="d31" doxytag="Textile::_repl" ></a><p> 505 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> 506 <tr> 507 <td class="mdRow"> 508 <table cellpadding="0" cellspacing="0" border="0"> 509 <tr> 510 <td class="md" nowrap valign="top"> Textile::_repl </td> 511 <td class="md" valign="top">( </td> 512 <td class="md" nowrap valign="top">&$ </td> 513 <td class="mdname" nowrap> <em>array</em>, </td> 514 </tr> 515 <tr> 516 <td class="md" nowrap align="right"></td> 517 <td></td> 518 <td class="md" nowrap>$ </td> 519 <td class="mdname" nowrap> <em>str</em></td> 520 </tr> 521 <tr> 522 <td></td> 523 <td class="md">) </td> 524 <td class="md" colspan="2"><code> [private]</code></td> 525 </tr> 526 </table> 527 </td> 528 </tr> 529 </table> 530 <table cellspacing=5 cellpadding=0 border=0> 531 <tr> 532 <td> 533 534 </td> 535 <td> 536 537 <p> 538 An internal routine that takes a string and appends it to an array. It returns a marker that is used later to restore the preserved string.<p> 539 <dl compact><dt><b>Parameters:</b></dt><dd> 540 <table border="0" cellspacing="2" cellpadding="0"> 541 <tr><td></td><td valign=top><em>$array</em> </td><td>The <code>array</code> in which to store the replacement text. </td></tr> 542 <tr><td></td><td valign=top><em>$str</em> </td><td>A <code>string</code> specifying the replacement text.</td></tr> 543 </table> 544 </dl> 545 <dl compact><dt><b>Returns:</b></dt><dd>A <code>string</code> containing a temporary marker for the replacement. </dd></dl> 546 547 <p> 548 Definition at line <a class="el" href="Textile_8php-source.html#l03162">3162</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>. </td> 549 </tr> 550 </table> 551 <a class="anchor" name="d30" doxytag="Textile::_strip_borders" ></a><p> 552 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> 553 <tr> 554 <td class="mdRow"> 555 <table cellpadding="0" cellspacing="0" border="0"> 556 <tr> 557 <td class="md" nowrap valign="top"> Textile::_strip_borders </td> 558 <td class="md" valign="top">( </td> 559 <td class="md" nowrap valign="top">&$ </td> 560 <td class="mdname" nowrap> <em>pre</em>, </td> 561 </tr> 562 <tr> 563 <td class="md" nowrap align="right"></td> 564 <td></td> 565 <td class="md" nowrap>&$ </td> 566 <td class="mdname" nowrap> <em>post</em></td> 567 </tr> 568 <tr> 569 <td></td> 570 <td class="md">) </td> 571 <td class="md" colspan="2"><code> [private]</code></td> 572 </tr> 573 </table> 574 </td> 575 </tr> 576 </table> 577 <table cellspacing=5 cellpadding=0 border=0> 578 <tr> 579 <td> 580 581 </td> 582 <td> 583 584 <p> 585 This utility routine will take 'border' characters off of the given <code>$pre</code> and <code>$post</code> strings if they match one of these conditions: <pre> 586 $pre starts with '[', $post ends with ']' 587 $pre starts with '{', $post ends with '}' 588 </pre> If neither condition is met, then the <code>$pre</code> and <code>$post</code> values are left untouched.<p> 589 <dl compact><dt><b>Parameters:</b></dt><dd> 590 <table border="0" cellspacing="2" cellpadding="0"> 591 <tr><td></td><td valign=top><em>$pre</em> </td><td>A <code>string</code> specifying the prefix. </td></tr> 592 <tr><td></td><td valign=top><em>$post</em> </td><td>A <code>string</code> specifying the postfix. </td></tr> 593 </table> 594 </dl> 595 596 <p> 597 Definition at line <a class="el" href="Textile_8php-source.html#l03130">3130</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>. </td> 598 </tr> 599 </table> 600 <a class="anchor" name="d32" doxytag="Textile::_tokenize" ></a><p> 601 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> 602 <tr> 603 <td class="mdRow"> 604 <table cellpadding="0" cellspacing="0" border="0"> 605 <tr> 606 <td class="md" nowrap valign="top"> Textile::_tokenize </td> 607 <td class="md" valign="top">( </td> 608 <td class="md" nowrap valign="top">$ </td> 609 <td class="mdname1" valign="top" nowrap> <em>str</em> </td> 610 <td class="md" valign="top"> ) </td> 611 <td class="md" nowrap><code> [private]</code></td> 612 </tr> 613 </table> 614 </td> 615 </tr> 616 </table> 617 <table cellspacing=5 cellpadding=0 border=0> 618 <tr> 619 <td> 620 621 </td> 622 <td> 623 624 <p> 625 An internal routine responsible for breaking up a string into individual tag and plaintext elements.<p> 626 <dl compact><dt><b>Parameters:</b></dt><dd> 627 <table border="0" cellspacing="2" cellpadding="0"> 628 <tr><td></td><td valign=top><em>$str</em> </td><td>A <code>string</code> specifying the text to tokenize.</td></tr> 629 </table> 630 </dl> 631 <dl compact><dt><b>Returns:</b></dt><dd>An <code>array</code> containing the tag and text tokens. </dd></dl> 632 633 <p> 634 Definition at line <a class="el" href="Textile_8php-source.html#l03177">3177</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>. </td> 635 </tr> 636 </table> 637 <a class="anchor" name="d28" doxytag="Textile::_valign" ></a><p> 638 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> 639 <tr> 640 <td class="mdRow"> 641 <table cellpadding="0" cellspacing="0" border="0"> 642 <tr> 643 <td class="md" nowrap valign="top"> Textile::_valign </td> 644 <td class="md" valign="top">( </td> 645 <td class="md" nowrap valign="top">$ </td> 646 <td class="mdname1" valign="top" nowrap> <em>align</em> </td> 647 <td class="md" valign="top"> ) </td> 648 <td class="md" nowrap><code> [private]</code></td> 649 </tr> 650 </table> 651 </td> 652 </tr> 653 </table> 654 <table cellspacing=5 cellpadding=0 border=0> 655 <tr> 656 <td> 657 658 </td> 659 <td> 660 661 <p> 662 Returns the alignment keyword depending on the symbol passed.<p> 663 <ul> 664 <li> 665 <b><code>^</code></b><p> 666 becomes 'top'<p> 667 </li> 668 <li> 669 <b><code>~</code></b><p> 670 becomes 'bottom'<p> 671 </li> 672 <li> 673 <b><code>-</code></b><p> 674 becomes 'middle'<p> 675 </li> 676 </ul> 677 <p> 678 <dl compact><dt><b>Parameters:</b></dt><dd> 679 <table border="0" cellspacing="2" cellpadding="0"> 680 <tr><td></td><td valign=top><em>$align</em> </td><td>A <code>string</code> specifying the alignment code.</td></tr> 681 </table> 682 </dl> 683 <dl compact><dt><b>Returns:</b></dt><dd>A <code>string</code> containing the alignment text. </dd></dl> 684 685 <p> 686 Definition at line <a class="el" href="Textile_8php-source.html#l03063">3063</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>. </td> 687 </tr> 688 </table> 689 <a class="anchor" name="d9" doxytag="Textile::add_term" ></a><p> 690 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> 691 <tr> 692 <td class="mdRow"> 693 <table cellpadding="0" cellspacing="0" border="0"> 694 <tr> 695 <td class="md" nowrap valign="top"> Textile::add_term </td> 696 <td class="md" valign="top">( </td> 697 <td class="md" nowrap valign="top">$ </td> 698 <td class="mdname" nowrap> <em>dt</em>, </td> 699 </tr> 700 <tr> 701 <td class="md" nowrap align="right"></td> 702 <td></td> 703 <td class="md" nowrap>$ </td> 704 <td class="mdname" nowrap> <em>dd</em></td> 705 </tr> 706 <tr> 707 <td></td> 708 <td class="md">) </td> 709 <td class="md" colspan="2"><code> [private]</code></td> 710 </tr> 711 </table> 712 </td> 713 </tr> 714 </table> 715 <table cellspacing=5 cellpadding=0 border=0> 716 <tr> 717 <td> 718 719 </td> 720 <td> 721 722 <p> 723 Processes a single definition list item from the provided term and definition.<p> 724 <dl compact><dt><b>Parameters:</b></dt><dd> 725 <table border="0" cellspacing="2" cellpadding="0"> 726 <tr><td></td><td valign=top><em>$dt</em> </td><td>A <code>string</code> specifying the term to be defined. </td></tr> 727 <tr><td></td><td valign=top><em>$dd</em> </td><td>A <code>string</code> specifying the definition for the term.</td></tr> 728 </table> 729 </dl> 730 <dl compact><dt><b>Returns:</b></dt><dd>A <code>string</code> containing the formatted definition list item. </dd></dl> 731 732 <p> 733 Definition at line <a class="el" href="Textile_8php-source.html#l01824">1824</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>. </td> 734 </tr> 735 </table> 736 <a class="anchor" name="d17" doxytag="Textile::apply_filters" ></a><p> 737 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> 738 <tr> 739 <td class="mdRow"> 740 <table cellpadding="0" cellspacing="0" border="0"> 741 <tr> 742 <td class="md" nowrap valign="top"> Textile::apply_filters </td> 743 <td class="md" valign="top">( </td> 744 <td class="md" nowrap valign="top">$ </td> 745 <td class="mdname1" valign="top" nowrap> <em>args</em> </td> 746 <td class="md" valign="top"> ) </td> 747 <td class="md" nowrap><code> [private]</code></td> 748 </tr> 749 </table> 750 </td> 751 </tr> 752 </table> 753 <table cellspacing=5 cellpadding=0 border=0> 754 <tr> 755 <td> 756 757 </td> 758 <td> 759 760 <p> 761 The following attributes are allowed:<p> 762 <ul> 763 <li> 764 <b>text</b><p> 765 The text to be processed.<p> 766 </li> 767 <li> 768 <b>filters</b><p> 769 An array reference of filter names to run for the given text.<p> 770 </li> 771 </ul> 772 <p> 773 <dl compact><dt><b>Parameters:</b></dt><dd> 774 <table border="0" cellspacing="2" cellpadding="0"> 775 <tr><td></td><td valign=top><em>$args</em> </td><td>An <code>array</code> specifying the text and filters to apply.</td></tr> 776 </table> 777 </dl> 778 <dl compact><dt><b>Returns:</b></dt><dd>A <code>string</code> containing the filtered text. </dd></dl> 779 780 <p> 781 Definition at line <a class="el" href="Textile_8php-source.html#l02617">2617</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>. </td> 782 </tr> 783 </table> 784 <a class="anchor" name="a13" doxytag="Textile::char_encoding" ></a><p> 785 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> 786 <tr> 787 <td class="mdRow"> 788 <table cellpadding="0" cellspacing="0" border="0"> 789 <tr> 790 <td class="md" nowrap valign="top"> Textile::char_encoding </td> 791 <td class="md" valign="top">( </td> 792 <td class="md" nowrap valign="top">$ </td> 793 <td class="mdname1" valign="top" nowrap> <em>char_encoding</em> = <code>NULL</code> </td> 794 <td class="md" valign="top"> ) </td> 795 <td class="md" nowrap></td> 796 </tr> 797 </table> 798 </td> 799 </tr> 800 </table> 801 <table cellspacing=5 cellpadding=0 border=0> 802 <tr> 803 <td> 804 805 </td> 806 <td> 807 808 <p> 809 Gets or sets the character encoding logical flag. If character encoding is enabled, the htmlentities function is used to encode special characters. If character encoding is disabled, only <, >, " and & are encoded to HTML entities.<p> 810 <dl compact><dt><b>Parameters:</b></dt><dd> 811 <table border="0" cellspacing="2" cellpadding="0"> 812 <tr><td></td><td valign=top><em>$char_encoding</em> </td><td>If provided, a <code>bool</code> indicating whether or not this object should encode special characters.</td></tr> 813 </table> 814 </dl> 815 <dl compact><dt><b>Returns:</b></dt><dd>A true value if this object encodes special characters; a false value otherwise. </dd></dl> 816 817 <p> 818 Definition at line <a class="el" href="Textile_8php-source.html#l00558">558</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>. 819 <p> 820 References <a class="el" href="Textile_8php-source.html#l00558">char_encoding()</a>. 821 <p> 822 Referenced by <a class="el" href="Textile_8php-source.html#l00558">char_encoding()</a>, <a class="el" href="Textile_8php-source.html#l00433">charset()</a>, and <a class="el" href="Textile_8php-source.html#l00186">Textile()</a>. </td> 823 </tr> 824 </table> 825 <a class="anchor" name="a7" doxytag="Textile::charset" ></a><p> 826 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> 827 <tr> 828 <td class="mdRow">