238 lines
12 KiB
HTML
238 lines
12 KiB
HTML
|
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
|||
|
|
<head>
|
|||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|||
|
|
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
<title>PHPLib » \PHPUtil\Str</title>
|
|||
|
|
<meta name="author" content="Mike van Riel">
|
|||
|
|
<meta name="description" content="">
|
|||
|
|
<link href="../css/template.css" rel="stylesheet" media="all">
|
|||
|
|
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
|||
|
|
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
|||
|
|
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
|||
|
|
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
|||
|
|
</head>
|
|||
|
|
<body>
|
|||
|
|
<div class="navbar navbar-fixed-top">
|
|||
|
|
<div class="navbar-inner"><div class="container">
|
|||
|
|
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">PHPLib</a><div class="nav-collapse"><ul class="nav">
|
|||
|
|
<li class="dropdown">
|
|||
|
|
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
|||
|
|
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
|||
|
|
<li><a>Packages</a></li>
|
|||
|
|
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
|||
|
|
<li><a href="../packages/PHPLib.html"><i class="icon-folder-open"></i> PHPLib</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="dropdown" id="charts-menu">
|
|||
|
|
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
|||
|
|
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="dropdown" id="reports-menu">
|
|||
|
|
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
|||
|
|
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
|||
|
|
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
|||
|
|
<span class="label label-info">0</span></a></li>
|
|||
|
|
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
|||
|
|
<ul></ul></a></li>
|
|||
|
|
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
|||
|
|
<span class="label label-info">0</span></a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul></div>
|
|||
|
|
</div></div>
|
|||
|
|
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
|||
|
|
</div>
|
|||
|
|
<div id="___" class="container">
|
|||
|
|
<noscript><div class="alert alert-warning">
|
|||
|
|
Javascript is disabled; several features are only available
|
|||
|
|
if Javascript is enabled.
|
|||
|
|
</div></noscript>
|
|||
|
|
<div class="row">
|
|||
|
|
<div class="span4">
|
|||
|
|
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
|||
|
|
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
|||
|
|
</div>
|
|||
|
|
<ul class="side-nav nav nav-list">
|
|||
|
|
<li class="nav-header">
|
|||
|
|
<i class="icon-custom icon-method"></i> Methods</li>
|
|||
|
|
<li class="method public "><a href="#_" title="_ :: Return output from the last method"><span class="description">Return output from the last method</span><pre>_()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#__construct" title="__construct :: Constructor"><span class="description">Constructor</span><pre>__construct()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#__invoke" title="__invoke :: Enable using the object as a function"><span class="description">Enable using the object as a function</span><pre>__invoke()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#__toString" title="__toString :: Output from the last method"><span class="description">Output from the last method</span><pre>__toString()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#format" title="format :: Formats a string according to the pattern passed to the str() function"><span class="description">Formats a string according to the pattern passed to the str() function</span><pre>format()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#match" title="match :: Check whether a string matches the provided pattern"><span class="description">Check whether a string matches the provided pattern</span><pre>match()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#reg_replace" title="reg_replace :: String replacement via a regular expression"><span class="description">String replacement via a regular expression</span><pre>reg_replace()</pre></a></li>
|
|||
|
|
<li class="method public "><a href="#replace" title="replace :: Do a basic string replacement"><span class="description">Do a basic string replacement</span><pre>replace()</pre></a></li>
|
|||
|
|
<li class="nav-header">
|
|||
|
|
<i class="icon-custom icon-property"></i> Properties</li>
|
|||
|
|
<li class="nav-header protected">» Protected</li>
|
|||
|
|
<li class="property protected "><a href="#%24original" title="$original :: Original string to be modified"><span class="description">Original string to be modified</span><pre>$original</pre></a></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
<div class="span8">
|
|||
|
|
<a name="%5CPHPUtil%5CStr" id="\PHPUtil\Str"></a><ul class="breadcrumb">
|
|||
|
|
<li>
|
|||
|
|
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
|
|||
|
|
</li>
|
|||
|
|
<li><a href="../namespaces/PHPUtil.html">PHPUtil</a></li>
|
|||
|
|
<li class="active">
|
|||
|
|
<span class="divider">\</span><a href="../classes/PHPUtil.Str.html">Str</a>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<div href="../classes/PHPUtil.Str.html" class="element class">
|
|||
|
|
<p class="short_description">Wrapper over php string functions with a consistent argument system</p>
|
|||
|
|
<div class="details">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<h3>
|
|||
|
|
<i class="icon-custom icon-method"></i> Methods</h3>
|
|||
|
|
<a name="_" id="_"></a><div class="element clickable method public _" data-toggle="collapse" data-target="._ .collapse">
|
|||
|
|
<h2>Return output from the last method</h2>
|
|||
|
|
<pre>_() : mixed</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<h3>Returns</h3>
|
|||
|
|
<div class="subelement response"><code>mixed</code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
|||
|
|
<h2>Constructor</h2>
|
|||
|
|
<pre>__construct(string $string) : <a href="../classes/PHPUtil.Str.html">\PHPUtil\Str</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<h3>Parameters</h3>
|
|||
|
|
<div class="subelement argument">
|
|||
|
|
<h4>$string</h4>
|
|||
|
|
<code>string</code>
|
|||
|
|
</div>
|
|||
|
|
<h3>Returns</h3>
|
|||
|
|
<div class="subelement response"><code><a href="../classes/PHPUtil.Str.html">\PHPUtil\Str</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="__invoke" id="__invoke"></a><div class="element clickable method public __invoke" data-toggle="collapse" data-target=".__invoke .collapse">
|
|||
|
|
<h2>Enable using the object as a function</h2>
|
|||
|
|
<pre>__invoke(string $string) : \PHPUtil\$this</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<h3>Parameters</h3>
|
|||
|
|
<div class="subelement argument">
|
|||
|
|
<h4>$string</h4>
|
|||
|
|
<code>string</code>
|
|||
|
|
</div>
|
|||
|
|
<h3>Returns</h3>
|
|||
|
|
<div class="subelement response"><code>\PHPUtil\$this</code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="__toString" id="__toString"></a><div class="element clickable method public __toString" data-toggle="collapse" data-target=".__toString .collapse">
|
|||
|
|
<h2>Output from the last method</h2>
|
|||
|
|
<pre>__toString() : string</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<h3>Returns</h3>
|
|||
|
|
<div class="subelement response"><code>string</code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="format" id="format"></a><div class="element clickable method public format" data-toggle="collapse" data-target=".format .collapse">
|
|||
|
|
<h2>Formats a string according to the pattern passed to the str() function</h2>
|
|||
|
|
<pre>format(array $replacements) : \PHPUtil\$this</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<table class="table table-bordered"><tr>
|
|||
|
|
<th>see</th>
|
|||
|
|
<td>\PHPUtil\http://php.net/manual/function.sprintf.php</td>
|
|||
|
|
</tr></table>
|
|||
|
|
<h3>Parameters</h3>
|
|||
|
|
<div class="subelement argument">
|
|||
|
|
<h4>$replacements</h4>
|
|||
|
|
<code>array</code>
|
|||
|
|
</div>
|
|||
|
|
<h3>Returns</h3>
|
|||
|
|
<div class="subelement response"><code>\PHPUtil\$this</code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="match" id="match"></a><div class="element clickable method public match" data-toggle="collapse" data-target=".match .collapse">
|
|||
|
|
<h2>Check whether a string matches the provided pattern</h2>
|
|||
|
|
<pre>match(string $pattern) : bool</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<h3>Parameters</h3>
|
|||
|
|
<div class="subelement argument">
|
|||
|
|
<h4>$pattern</h4>
|
|||
|
|
<code>string</code>
|
|||
|
|
</div>
|
|||
|
|
<h3>Returns</h3>
|
|||
|
|
<div class="subelement response"><code>bool</code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="reg_replace" id="reg_replace"></a><div class="element clickable method public reg_replace" data-toggle="collapse" data-target=".reg_replace .collapse">
|
|||
|
|
<h2>String replacement via a regular expression</h2>
|
|||
|
|
<pre>reg_replace(mixed $pattern, mixed $replacement) : \PHPUtil\$this</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<table class="table table-bordered"><tr>
|
|||
|
|
<th>see</th>
|
|||
|
|
<td>\PHPUtil\http://php.net/manual/function.preg-replace.php</td>
|
|||
|
|
</tr></table>
|
|||
|
|
<h3>Parameters</h3>
|
|||
|
|
<div class="subelement argument">
|
|||
|
|
<h4>$pattern</h4>
|
|||
|
|
<code>mixed</code>
|
|||
|
|
</div>
|
|||
|
|
<div class="subelement argument">
|
|||
|
|
<h4>$replacement</h4>
|
|||
|
|
<code>mixed</code>
|
|||
|
|
</div>
|
|||
|
|
<h3>Returns</h3>
|
|||
|
|
<div class="subelement response"><code>\PHPUtil\$this</code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="replace" id="replace"></a><div class="element clickable method public replace" data-toggle="collapse" data-target=".replace .collapse">
|
|||
|
|
<h2>Do a basic string replacement</h2>
|
|||
|
|
<pre>replace(mixed $pattern, mixed $replacement) : \PHPUtil\$this</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<table class="table table-bordered"><tr>
|
|||
|
|
<th>see</th>
|
|||
|
|
<td>\PHPUtil\http://php.net/manual/function.str-replace.php</td>
|
|||
|
|
</tr></table>
|
|||
|
|
<h3>Parameters</h3>
|
|||
|
|
<div class="subelement argument">
|
|||
|
|
<h4>$pattern</h4>
|
|||
|
|
<code>mixed</code>
|
|||
|
|
</div>
|
|||
|
|
<div class="subelement argument">
|
|||
|
|
<h4>$replacement</h4>
|
|||
|
|
<code>mixed</code>
|
|||
|
|
</div>
|
|||
|
|
<h3>Returns</h3>
|
|||
|
|
<div class="subelement response"><code>\PHPUtil\$this</code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<h3>
|
|||
|
|
<i class="icon-custom icon-property"></i> Properties</h3>
|
|||
|
|
<a name="%24original" id="$original"> </a><div class="element clickable property protected $original" data-toggle="collapse" data-target=".$original .collapse">
|
|||
|
|
<h2>Original string to be modified</h2>
|
|||
|
|
<pre>$original : string</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="row"><footer class="span12">
|
|||
|
|
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
|||
|
|
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
|||
|
|
generated on 2013-01-31T15:19:19-05:00.<br></footer></div>
|
|||
|
|
</div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|