<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Luminous: LuminousStringSearch Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Luminous
 <span id="projectnumber">git-master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="classLuminousStringSearch-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LuminousStringSearch Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A basic preg_match wrapper which caches its results.
<a href="classLuminousStringSearch.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:add9f60d00e3eaea29d0e577e84292256"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add9f60d00e3eaea29d0e577e84292256"></a>
 </td><td class="memItemRight" valign="bottom"><b>__construct</b> ($str)</td></tr>
<tr class="memitem:ae6b1a2b900b6d8593cfd93272bc72ef2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStringSearch.html#ae6b1a2b900b6d8593cfd93272bc72ef2">match</a> ($search, $index, &$matches)</td></tr>
<tr class="memdesc:ae6b1a2b900b6d8593cfd93272bc72ef2"><td class="mdescLeft"> </td><td class="mdescRight">Performs a search for the given pattern past the given index. <a href="#ae6b1a2b900b6d8593cfd93272bc72ef2"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a409d9de167e4668acbe3da71f2bfa277"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStringSearch.html#a409d9de167e4668acbe3da71f2bfa277">$cache</a> = array()</td></tr>
<tr class="memitem:a2ed7bad26a3e255195bb00c12a50e49c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ed7bad26a3e255195bb00c12a50e49c"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classLuminousStringSearch.html#a2ed7bad26a3e255195bb00c12a50e49c">$string</a></td></tr>
<tr class="memdesc:a2ed7bad26a3e255195bb00c12a50e49c"><td class="mdescLeft"> </td><td class="mdescRight">A copy of the string to operate on. <br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A basic preg_match wrapper which caches its results. </p>
<dl class="section note"><dt>Note</dt><dd>This class is used by <a class="el" href="classScanner.html" title="Base string scanning class.">Scanner</a> and should not need to be used by anything else.</dd></dl>
<p>A class encapsulating the process of searching for a substring efficiently it handles caching of results.</p>
<dl class="section warning"><dt>Warning</dt><dd>One instance should be used only incrementally along a string. i.e. do not call it with index = 5 then index = 1.</dd></dl>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="ae6b1a2b900b6d8593cfd93272bc72ef2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LuminousStringSearch::match </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$search</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>$index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">& </td>
<td class="paramname"><em>$matches</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a search for the given pattern past the given index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$search</td><td>the pattern to search for </td></tr>
<tr><td class="paramname">$index</td><td>the minimum string index (offset) of a result </td></tr>
<tr><td class="paramname">$matches</td><td>a reference to the return location of the match groups </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the index or false if no match is found. </dd></dl>
</div>
</div>
<h2>Member Data Documentation</h2>
<a class="anchor" id="a409d9de167e4668acbe3da71f2bfa277"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LuminousStringSearch::$cache = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The cache is stored as a map of pattern => result, the result is an array of: (0=>index, 1=>match_groups), OR, it is false if there are no more results left in the string. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/core/strsearch.class.php</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 12 2013 16:03:50 for Luminous by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>