PageRenderTime 66ms CodeModel.GetById 25ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/Liquid/LiquidRegexp.html

http://github.com/m3talsmith/php-liquid
HTML | 389 lines | 340 code | 49 blank | 0 comment | 0 complexity | 12a40bea18afc7ce4d977dc24240be43 MD5 | raw file
    

  1. <html>
    2. 

  2. <head>
    3. 

  3. <title>Docs For Class LiquidRegexp</title>
    4. 

  4. <link rel="stylesheet" type="text/css" href="../media/style.css">
    5. 

  5. </head>
    6. 

  6. <body>
    7. 

  7. 

  8. <table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
    9. 

  9.   <tr>
    10. 

  10.     <td class="header_top">Liquid</td>
    11. 

  11.   </tr>
    12. 

  12.   <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
    13. 

  13.   <tr>
    14. 

  14.     <td class="header_menu">
    15. 

  15.   		  [ <a href="../classtrees_Liquid.html" class="menu">class tree: Liquid</a> ]
    16. 

  16. 		  [ <a href="../elementindex_Liquid.html" class="menu">index: Liquid</a> ]
    17. 

  17. 		  [ <a href="../elementindex.html" class="menu">all elements</a> ]
    18. 

  18.     </td>
    19. 

  19.   </tr>
    20. 

  20.   <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
    21. 

  21. </table>
    22. 

  22. 

  23. <table width="100%" border="0" cellpadding="0" cellspacing="0">
    24. 

  24.   <tr valign="top">
    25. 

  25.     <td width="200" class="menu">
    26. 

  26.       <b>Packages:</b><br />
    27. 

  27.               <a href="../li_Liquid.html">Liquid</a><br />
    28. 

  28.             <br /><br />
    29. 

  29.                         <b>Files:</b><br />
    30. 

  30.       	  <div class="package">
    31. 

  31. 			<a href="../Liquid/_lib_liquid_block_php.html">		block.php
    32. 

  32. 		</a><br>
    33. 

  33. 			<a href="../Liquid/_lib_liquid_context_php.html">		context.php
    34. 

  34. 		</a><br>
    35. 

  35. 			<a href="../Liquid/_lib_liquid_document_php.html">		document.php
    36. 

  36. 		</a><br>
    37. 

  37. 			<a href="../Liquid/_lib_liquid_drop_php.html">		drop.php
    38. 

  38. 		</a><br>
    39. 

  39. 			<a href="../Liquid/_lib_liquid_file_system_php.html">		file_system.php
    40. 

  40. 		</a><br>
    41. 

  41. 			<a href="../Liquid/_lib_liquid_filterbank_php.html">		filterbank.php
    42. 

  42. 		</a><br>
    43. 

  43. 			<a href="../Liquid/_lib_liquid_htmltags_php.html">		htmltags.php
    44. 

  44. 		</a><br>
    45. 

  45. 			<a href="../Liquid/_lib_liquid_php.html">		liquid.php
    46. 

  46. 		</a><br>
    47. 

  47. 			<a href="../Liquid/_lib_liquid_standardfilters_php.html">		standardfilters.php
    48. 

  48. 		</a><br>
    49. 

  49. 			<a href="../Liquid/_lib_liquid_standardtags_php.html">		standardtags.php
    50. 

  50. 		</a><br>
    51. 

  51. 			<a href="../Liquid/_lib_liquid_support_php.html">		support.php
    52. 

  52. 		</a><br>
    53. 

  53. 			<a href="../Liquid/_lib_liquid_tag_php.html">		tag.php
    54. 

  54. 		</a><br>
    55. 

  55. 			<a href="../Liquid/_lib_liquid_template_php.html">		template.php
    56. 

  56. 		</a><br>
    57. 

  57. 			<a href="../Liquid/_lib_liquid_variable_php.html">		variable.php
    58. 

  58. 		</a><br>
    59. 

  59. 	  </div><br />
    60. 

  60.       
    61. 

  61.             <b>Classes:</b><br />
    62. 

  62.         <div class="package">
    63. 

  63. 		    		<a href="../Liquid/AssignLiquidTag.html">AssignLiquidTag</a><br />
    64. 

  64. 	    		<a href="../Liquid/CaptureLiquidTag.html">CaptureLiquidTag</a><br />
    65. 

  65. 	    		<a href="../Liquid/CaseLiquidTag.html">CaseLiquidTag</a><br />
    66. 

  66. 	    		<a href="../Liquid/CommentLiquidTag.html">CommentLiquidTag</a><br />
    67. 

  67. 	    		<a href="../Liquid/CycleLiquidTag.html">CycleLiquidTag</a><br />
    68. 

  68. 	    		<a href="../Liquid/ForLiquidTag.html">ForLiquidTag</a><br />
    69. 

  69. 	    		<a href="../Liquid/IfLiquidTag.html">IfLiquidTag</a><br />
    70. 

  70. 	    		<a href="../Liquid/IncludeLiquidTag.html">IncludeLiquidTag</a><br />
    71. 

  71. 	    		<a href="../Liquid/LiquidBlankFileSystem.html">LiquidBlankFileSystem</a><br />
    72. 

  72. 	    		<a href="../Liquid/LiquidBlock.html">LiquidBlock</a><br />
    73. 

  73. 	    		<a href="../Liquid/LiquidContext.html">LiquidContext</a><br />
    74. 

  74. 	    		<a href="../Liquid/LiquidDecisionBlock.html">LiquidDecisionBlock</a><br />
    75. 

  75. 	    		<a href="../Liquid/LiquidDocument.html">LiquidDocument</a><br />
    76. 

  76. 	    		<a href="../Liquid/LiquidDrop.html">LiquidDrop</a><br />
    77. 

  77. 	    		<a href="../Liquid/LiquidFilterbank.html">LiquidFilterbank</a><br />
    78. 

  78. 	    		<a href="../Liquid/LiquidLocalFileSystem.html">LiquidLocalFileSystem</a><br />
    79. 

  79. 	    		<a href="../Liquid/LiquidRegexp.html">LiquidRegexp</a><br />
    80. 

  80. 	    		<a href="../Liquid/LiquidStandardFilters.html">LiquidStandardFilters</a><br />
    81. 

  81. 	    		<a href="../Liquid/LiquidTag.html">LiquidTag</a><br />
    82. 

  82. 	    		<a href="../Liquid/LiquidTemplate.html">LiquidTemplate</a><br />
    83. 

  83. 	    		<a href="../Liquid/LiquidVariable.html">LiquidVariable</a><br />
    84. 

  84. 	    		<a href="../Liquid/TableRowLiquidTag.html">TableRowLiquidTag</a><br />
    85. 

  85. 	  </div>
    86. 

  86.                 </td>
    87. 

  87.     <td>
    88. 

  88.       <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
    89. 

  89. 

  90. <h1>Class: LiquidRegexp</h1>
    91. 

  91. Source Location: /liquid/support.php<br /><br />
    92. 

  92. 

  93. 

  94. <table width="100%" border="0">
    95. 

  95. <tr><td valign="top">
    96. 

  96. 

  97. <h3><a href="#class_details">Class Overview</a></h3>
    98. 

  98. <pre></pre><br />
    99. 

  99. <div class="description">A support class for regular expressions</div><br /><br />
    100. 

  100. 

  101. 

  102. 

  103. 

  104. 

  105. 

  106. 

  107. </td>
    108. 

  108. 

  109. <td valign="top">
    110. 

  110. <h3><a href="#class_vars">Variables</a></h3>
    111. 

  111. <ul>
    112. 

  112.     <li><a href="../Liquid/LiquidRegexp.html#var$matches">$matches</a></li>
    113. 

  113.     <li><a href="../Liquid/LiquidRegexp.html#var$pattern">$pattern</a></li>
    114. 

  114.   </ul>
    115. 

  115. </td>
    116. 

  116. 

  117. 

  118. <td valign="top">
    119. 

  119. <h3><a href="#class_methods">Methods</a></h3>
    120. 

  120. <ul>
    121. 

  121.     <li><a href="../Liquid/LiquidRegexp.html#methodLiquidRegexp">LiquidRegexp</a></li>
    122. 

  122.     <li><a href="../Liquid/LiquidRegexp.html#methodmatch">match</a></li>
    123. 

  123.     <li><a href="../Liquid/LiquidRegexp.html#methodmatch_all">match_all</a></li>
    124. 

  124.     <li><a href="../Liquid/LiquidRegexp.html#methodquote">quote</a></li>
    125. 

  125.     <li><a href="../Liquid/LiquidRegexp.html#methodscan">scan</a></li>
    126. 

  126.     <li><a href="../Liquid/LiquidRegexp.html#methodsplit">split</a></li>
    127. 

  127.   </ul>
    128. 

  128. </td>
    129. 

  129. 

  130. </tr></table>
    131. 

  131. <hr />
    132. 

  132. 

  133. <table width="100%" border="0"><tr>
    134. 

  134. 

  135. 

  136. 

  137. 

  138. 

  139. 

  140. </tr></table>
    141. 

  141. <hr />
    142. 

  142. 

  143. <a name="class_details"></a>
    144. 

  144. <h3>Class Details</h3>
    145. 

  145. <div class="tags">
    146. 

  146. [line 22]<br />
    147. 

  147. A support class for regular expressions<br /><br /></div><br /><br />
    148. 

  148. <div class="top">[ <a href="#top">Top</a> ]</div><br />
    149. 

  149. 

  150. <hr />
    151. 

  151. <a name="class_vars"></a>
    152. 

  152. <h3>Class Variables</h3>
    153. 

  153. <div class="tags">
    154. 

  154. 	<a name="var$matches"></a>
    155. 

  155. 	<p></p>
    156. 

  156. 	<h4>$matches = <span class="value"></span></h4>
    157. 

  157. 	<p>[line 37]</p>
    158. 

  158.   The matches from the last method called<br /><br />
    159. 

  159.   <br />
    160. 

  160. 	<div class="tags">
    161. 

  161.   <table border="0" cellspacing="0" cellpadding="0">
    162. 

  162.     <tr>
    163. 

  163.       <td><b>Type:</b>&nbsp;&nbsp;</td>
    164. 

  164.       <td>array;</td>
    165. 

  165.     </tr>
    166. 

  166.       </table>
    167. 

  167. 	</div><br /><br />
    168. 

  168. 	<div class="top">[ <a href="#top">Top</a> ]</div><br />
    169. 

  169. 	<a name="var$pattern"></a>
    170. 

  170. 	<p></p>
    171. 

  171. 	<h4>$pattern = <span class="value"></span></h4>
    172. 

  172. 	<p>[line 29]</p>
    173. 

  173.   The regexp pattern<br /><br />
    174. 

  174.   <br />
    175. 

  175. 	<div class="tags">
    176. 

  176.   <table border="0" cellspacing="0" cellpadding="0">
    177. 

  177.     <tr>
    178. 

  178.       <td><b>Type:</b>&nbsp;&nbsp;</td>
    179. 

  179.       <td>string</td>
    180. 

  180.     </tr>
    181. 

  181.       </table>
    182. 

  182. 	</div><br /><br />
    183. 

  183. 	<div class="top">[ <a href="#top">Top</a> ]</div><br />
    184. 

  184. </div><br />
    185. 

  185. 

  186. <hr />
    187. 

  187. <a name="class_methods"></a>
    188. 

  188. <h3>Class Methods</h3>
    189. 

  189. <div class="tags">
    190. 

  190.   <hr />
    191. 

  191. 	<a name="methodLiquidRegexp"></a>
    192. 

  192. 	<h3>constructor LiquidRegexp <span class="smalllinenumber">[line 45]</span></h3>
    193. 

  193. 	<div class="function">
    194. 

  194.     <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    195. 

  195.     <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
    196. 

  196. 		<code>Regexp LiquidRegexp(
    197. 

  197. string
    198. 

  198. $pattern)</code>
    199. 

  199.     </td></tr></table>
    200. 

  200.     </td></tr></table><br />
    201. 

  201. 	
    202. 

  202. 		Constructor<br /><br /><br /><br />
    203. 

  203. 

  204. 

  205.         <h4>Parameters:</h4>
    206. 

  206.     <div class="tags">
    207. 

  207.     <table border="0" cellspacing="0" cellpadding="0">
    208. 

  208.           <tr>
    209. 

  209.         <td class="type">string&nbsp;&nbsp;</td>
    210. 

  210.         <td><b>$pattern</b>&nbsp;&nbsp;</td>
    211. 

  211.         <td></td>
    212. 

  212.       </tr>
    213. 

  213.         </table>
    214. 

  214.     </div><br />
    215. 

  215.         <div class="top">[ <a href="#top">Top</a> ]</div>
    216. 

  216.   </div>
    217. 

  217.   <hr />
    218. 

  218. 	<a name="methodmatch"></a>
    219. 

  219. 	<h3>method match <span class="smalllinenumber">[line 102]</span></h3>
    220. 

  220. 	<div class="function">
    221. 

  221.     <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    222. 

  222.     <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
    223. 

  223. 		<code>int match(
    224. 

  224. string
    225. 

  225. $string)</code>
    226. 

  226.     </td></tr></table>
    227. 

  227.     </td></tr></table><br />
    228. 

  228. 	
    229. 

  229. 		Matches the given string. Only matches once.<br /><br /><br /><br />
    230. 

  230. <h4>Tags:</h4>
    231. 

  231. <div class="tags">
    232. 

  232. <table border="0" cellspacing="0" cellpadding="0">
    233. 

  233.   <tr>
    234. 

  234.     <td><b>return:</b>&nbsp;&nbsp;</td><td>1 if there was a match, 0 if there wasn't</td>
    235. 

  235.   </tr>
    236. 

  236. </table>
    237. 

  237. </div>
    238. 

  238. <br /><br />
    239. 

  239. 

  240. 

  241.         <h4>Parameters:</h4>
    242. 

  242.     <div class="tags">
    243. 

  243.     <table border="0" cellspacing="0" cellpadding="0">
    244. 

  244.           <tr>
    245. 

  245.         <td class="type">string&nbsp;&nbsp;</td>
    246. 

  246.         <td><b>$string</b>&nbsp;&nbsp;</td>
    247. 

  247.         <td></td>
    248. 

  248.       </tr>
    249. 

  249.         </table>
    250. 

  250.     </div><br />
    251. 

  251.         <div class="top">[ <a href="#top">Top</a> ]</div>
    252. 

  252.   </div>
    253. 

  253.   <hr />
    254. 

  254. 	<a name="methodmatch_all"></a>
    255. 

  255. 	<h3>method match_all <span class="smalllinenumber">[line 112]</span></h3>
    256. 

  256. 	<div class="function">
    257. 

  257.     <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    258. 

  258.     <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
    259. 

  259. 		<code>int match_all(
    260. 

  260. string
    261. 

  261. $string)</code>
    262. 

  262.     </td></tr></table>
    263. 

  263.     </td></tr></table><br />
    264. 

  264. 	
    265. 

  265. 		Matches the given string. Matches all.<br /><br /><br /><br />
    266. 

  266. <h4>Tags:</h4>
    267. 

  267. <div class="tags">
    268. 

  268. <table border="0" cellspacing="0" cellpadding="0">
    269. 

  269.   <tr>
    270. 

  270.     <td><b>return:</b>&nbsp;&nbsp;</td><td>The number of matches</td>
    271. 

  271.   </tr>
    272. 

  272. </table>
    273. 

  273. </div>
    274. 

  274. <br /><br />
    275. 

  275. 

  276. 

  277.         <h4>Parameters:</h4>
    278. 

  278.     <div class="tags">
    279. 

  279.     <table border="0" cellspacing="0" cellpadding="0">
    280. 

  280.           <tr>
    281. 

  281.         <td class="type">string&nbsp;&nbsp;</td>
    282. 

  282.         <td><b>$string</b>&nbsp;&nbsp;</td>
    283. 

  283.         <td></td>
    284. 

  284.       </tr>
    285. 

  285.         </table>
    286. 

  286.     </div><br />
    287. 

  287.         <div class="top">[ <a href="#top">Top</a> ]</div>
    288. 

  288.   </div>
    289. 

  289.   <hr />
    290. 

  290. 	<a name="methodquote"></a>
    291. 

  291. 	<h3>method quote <span class="smalllinenumber">[line 62]</span></h3>
    292. 

  292. 	<div class="function">
    293. 

  293.     <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    294. 

  294.     <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
    295. 

  295. 		<code>string quote(
    296. 

  296. string
    297. 

  297. $string)</code>
    298. 

  298.     </td></tr></table>
    299. 

  299.     </td></tr></table><br />
    300. 

  300. 	
    301. 

  301. 		Quotes regular expression characters<br /><br /><br /><br />
    302. 

  302. 

  303. 

  304.         <h4>Parameters:</h4>
    305. 

  305.     <div class="tags">
    306. 

  306.     <table border="0" cellspacing="0" cellpadding="0">
    307. 

  307.           <tr>
    308. 

  308.         <td class="type">string&nbsp;&nbsp;</td>
    309. 

  309.         <td><b>$string</b>&nbsp;&nbsp;</td>
    310. 

  310.         <td></td>
    311. 

  311.       </tr>
    312. 

  312.         </table>
    313. 

  313.     </div><br />
    314. 

  314.         <div class="top">[ <a href="#top">Top</a> ]</div>
    315. 

  315.   </div>
    316. 

  316.   <hr />
    317. 

  317. 	<a name="methodscan"></a>
    318. 

  318. 	<h3>method scan <span class="smalllinenumber">[line 73]</span></h3>
    319. 

  319. 	<div class="function">
    320. 

  320.     <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    321. 

  321.     <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
    322. 

  322. 		<code>array scan(
    323. 

  323. string
    324. 

  324. $string)</code>
    325. 

  325.     </td></tr></table>
    326. 

  326.     </td></tr></table><br />
    327. 

  327. 	
    328. 

  328. 		Returns an array of matches for the string in the same way as Ruby's scan method<br /><br /><br /><br />
    329. 

    330. 

  330. 

  331.         <h4>Parameters:</h4>
    332. 

  332.     <div class="tags">
    333. 

  333.     <table border="0" cellspacing="0" cellpadding="0">
    334. 

  334.           <tr>
    335. 

  335.         <td class="type">string&nbsp;&nbsp;</td>
    336. 

  336.         <td><b>$string</b>&nbsp;&nbsp;</td>
    337. 

  337.         <td></td>
    338. 

  338.       </tr>
    339. 

  339.         </table>
    340. 

  340.     </div><br />
    341. 

  341.         <div class="top">[ <a href="#top">Top</a> ]</div>
    342. 

  342.   </div>
    343. 

  343.   <hr />
    344. 

  344. 	<a name="methodsplit"></a>
    345. 

  345. 	<h3>method split <span class="smalllinenumber">[line 124]</span></h3>
    346. 

  346. 	<div class="function">
    347. 

  347.     <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    348. 

  348.     <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
    349. 

  349. 		<code>array split(
    350. 

  350. string
    351. 

  351. $string, [int
    352. 

  352. $limit = null])</code>
    353. 

  353.     </td></tr></table>
    354. 

  354.     </td></tr></table><br />
    355. 

  355. 	
    356. 

  356. 		Splits the given string<br /><br /><br /><br />
    357. 

  357. 

  358. 

  359.         <h4>Parameters:</h4>
    360. 

  360.     <div class="tags">
    361. 

  361.     <table border="0" cellspacing="0" cellpadding="0">
    362. 

  362.           <tr>
    363. 

  363.         <td class="type">string&nbsp;&nbsp;</td>
    364. 

  364.         <td><b>$string</b>&nbsp;&nbsp;</td>
    365. 

  365.         <td></td>
    366. 

  366.       </tr>
    367. 

  367.           <tr>
    368. 

  368.         <td class="type">int&nbsp;&nbsp;</td>
    369. 

  369.         <td><b>$limit</b>&nbsp;&nbsp;</td>
    370. 

  370.         <td>Limits the amount of results returned</td>
    371. 

  371.       </tr>
    372. 

  372.         </table>
    373. 

  373.     </div><br />
    374. 

  374.         <div class="top">[ <a href="#top">Top</a> ]</div>
    375. 

  375.   </div>
    376. 

  376. </div><br />
    377. 

  377. 

  378. 

  379.         <div class="credit">
    380. 

  380. 		    <hr />
    381. 

  381. 		    Documentation generated on Mon, 26 Jun 2006 22:45:46 -0400 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a>
    382. 

  382. 	      </div>
    383. 

  383.       </td></tr></table>
    384. 

  384.     </td>
    385. 

  385.   </tr>
    386. 

  386. </table>
    387. 

  387. 

  388. </body>
    389. 

  389. </html>
    390.