phpdoc/Library/Helper/Text.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Library\Helper\Text | Library</title>
<link rel="stylesheet" type="text/css" href="../../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../../css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="../../css/sami.css">
<script src="../../js/jquery-1.11.1.min.js"></script>
<script src="../../js/bootstrap.min.js"></script>
<script src="../../js/typeahead.min.js"></script>
<script src="../../sami.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
</head>
<body id="class" data-name="class:Library_Helper_Text" data-root-path="../../">
<div id="content">
<div id="left-column">
<div id="control-panel">
<form id="search-form" action="../../search.html" method="GET">
<span class="glyphicon glyphicon-search"></span>
<input name="search"
class="typeahead form-control"
type="search"
placeholder="Search">
</form>
</div>
<div id="api-tree"></div>
</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">Library</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="../../classes.html">Classes</a></li>
<li><a href="../../namespaces.html">Namespaces</a></li>
<li><a href="../../interfaces.html">Interfaces</a></li>
<li><a href="../../traits.html">Traits</a></li>
<li><a href="../../doc-index.html">Index</a></li>
<li><a href="../../search.html">Search</a></li>
</ul>
</div>
</div>
</nav>
<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">class</span></li>
<li><a href="../../Library.html">Library</a></li>
<li><a href="../../Library/Helper.html">Helper</a></li>
<li>Text</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>Text</h1>
</div>
<p> class
<strong>Text</strong>
</p>
<div class="description">
<p>Text helper</p> <p>As for all helpers, all methods are statics.</p>
<p>For convenience, the best practice is to use:</p>
<pre><code>use Library\Helper\Text as TextHelper;
</code></pre>
</p> </div>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
static
string
</div>
<div class="col-md-8 type">
<a href="#method_cut">cut</a>(
string $string = '',
int $length = 120,
string $end_str = ' ...')
<p>Truncate a string at a maximum length, adding it a suffix like '.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
string
</div>
<div class="col-md-8 type">
<a href="#method_wrap">wrap</a>($str = '',
int $line_length = 75,
string $separator = PHP_EOL)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
string
</div>
<div class="col-md-8 type">
<a href="#method_stripSpecialChars">stripSpecialChars</a>(
string $string = '',
string $authorized = '')
<p>Strip all special characters in a string</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
string
</div>
<div class="col-md-8 type">
<a href="#method_slugify">slugify</a>(
string $string = '')
<p>Get a slugified string</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
string
</div>
<div class="col-md-8 type">
<a href="#method_getHumanReadable">getHumanReadable</a>(
string $string = '')
<p>Transform a string to a human readable one</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
string
</div>
<div class="col-md-8 type">
<a href="#method_toCamelCase">toCamelCase</a>(
string $name = '',
string $replace = '_',
bool $capitalize_first_char = true)
<p>Transform a name in CamelCase</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
string
</div>
<div class="col-md-8 type">
<a href="#method_fromCamelCase">fromCamelCase</a>(
string $name = '',
string $replace = '_',
bool $lowerize_first_char = true)
<p>Transform a name from CamelCase to other</p> </div>
<div class="col-md-2"></div>
</div>
</div>
<h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method_cut">
<div class="location">at line 48</div>
<code> static
string
<strong>cut</strong>(
string $string = '',
int $length = 120,
string $end_str = ' ...')</code>
</h3>
<div class="details">
<div class="method-description">
<p>Truncate a string at a maximum length, adding it a suffix like '.</p> <p>..'</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$string</td>
<td>The string to cut</td>
</tr>
<tr>
<td>
int</td>
<td>$length</td>
<td>The maximum length to keep (<code>120</code> by default)</td>
</tr>
<tr>
<td>
string</td>
<td>$end_str</td>
<td>The suffix to add if the string was cut (<code>...</code> by default)</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_wrap">
<div class="location">at line 74</div>
<code> static
string
<strong>wrap</strong>($str = '',
int $line_length = 75,
string $separator = PHP_EOL)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$str</td>
<td>
</td>
</tr>
<tr>
<td>
int</td>
<td>$line_length</td>
<td>
</td>
</tr>
<tr>
<td>
string</td>
<td>$separator</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_stripSpecialChars">
<div class="location">at line 99</div>
<code> static
string
<strong>stripSpecialChars</strong>(
string $string = '',
string $authorized = '')</code>
</h3>
<div class="details">
<div class="method-description">
<p>Strip all special characters in a string</p> <p>This will replace all accentuated letters by their non-accentuated
equivalent and delete all other special characters (including space by default).</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$string</td>
<td>The string to format</td>
</tr>
<tr>
<td>
string</td>
<td>$authorized</td>
<td>Some authorized characters</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_slugify">
<div class="location">at line 126</div>
<code> static
string
<strong>slugify</strong>(
string $string = '')</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get a slugified string</p> <p>By Miguel Santirso (http://sourcecookbook.com/en/recipes/8/function-to-slugify-strings-in-php)</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$string</td>
<td>The string to format</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getHumanReadable">
<div class="location">at line 142</div>
<code> static
string
<strong>getHumanReadable</strong>(
string $string = '')</code>
</h3>
<div class="details">
<div class="method-description">
<p>Transform a string to a human readable one</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$string</td>
<td>The string to transform</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>The transformed version of <code>$string</code></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_toCamelCase">
<div class="location">at line 155</div>
<code> static
string
<strong>toCamelCase</strong>(
string $name = '',
string $replace = '_',
bool $capitalize_first_char = true)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Transform a name in CamelCase</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>The string to transform</td>
</tr>
<tr>
<td>
string</td>
<td>$replace</td>
<td>Replacement character</td>
</tr>
<tr>
<td>
bool</td>
<td>$capitalize_first_char</td>
<td>May the first letter be in upper case (default is <code>true</code>)</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>The CamelCase version of <code>$name</code></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_fromCamelCase">
<div class="location">at line 175</div>
<code> static
string
<strong>fromCamelCase</strong>(
string $name = '',
string $replace = '_',
bool $lowerize_first_char = true)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Transform a name from CamelCase to other</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>The string to transform</td>
</tr>
<tr>
<td>
string</td>
<td>$replace</td>
<td>Replacement character</td>
</tr>
<tr>
<td>
bool</td>
<td>$lowerize_first_char</td>
<td>May the first letter be in lower case (default is <code>true</code>)</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>The un-CamelCase version of <code>$name</code></td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
</div>
</div>
</div>
</body>
</html>