| Current Path : /webspace/www.babilon.be/html/modules/CGExtensions/docs/apidoc/classes/ |
| Current File : //webspace/www.babilon.be/html/modules/CGExtensions/docs/apidoc/classes/cge_string.html |
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
<meta charset="utf-8"/>
<title>CGExtensions 1.45</title>
<meta name="author" content=""/>
<meta name="description" content=""/>
<link href="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
<link href="https://netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.min.css" rel="stylesheet">
<link href="../css/prism.css" rel="stylesheet" media="all"/>
<link href="../css/template.css" rel="stylesheet" media="all"/>
<!--[if lt IE 9]>
<script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
<![endif]-->
<script src="https://code.jquery.com/jquery-1.10.2.min.js" type="text/javascript"></script>
<script src="https://code.jquery.com/ui/1.10.3/jquery-ui.min.js" type="text/javascript"></script>
<script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script>
<script src="../js/jquery.smooth-scroll.js"></script>
<script src="../js/prism.min.js"></script>
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
<script type="text/javascript">
function loadExternalCodeSnippets() {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
var src = pre.getAttribute('data-src');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist or is empty';
}
}
};
xhr.send(null);
});
}
$(document).ready(function(){
loadExternalCodeSnippets();
});
$('#source-view').on('shown', function () {
loadExternalCodeSnippets();
})
</script>
<link rel="shortcut icon" href="../images/favicon.ico"/>
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
<link rel="apple-touch-icon" sizes="114x114" href="../images/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">
<i class="icon-ellipsis-vertical"></i>
</a>
<a class="brand" href="../index.html">CGExtensions 1.45</a>
<div class="nav-collapse">
<ul class="nav pull-right">
<li class="dropdown">
<a href="../index.html" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="../namespaces/CGExtensions.html">\CGExtensions</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../graphs/class.html">
<i class="icon-list-alt"></i> Class hierarchy diagram
</a>
</li>
</ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">93</span>
</a>
</li>
<li>
<a href="../reports/markers.html">
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">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-fluid">
<section class="row-fluid">
<div class="span2 sidebar">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-571154886"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-571154886" class="accordion-body collapse in">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-636086758"></a>
<a href="../namespaces/CGExtensions.html" style="margin-left: 30px; padding-left: 0">CGExtensions</a>
</div>
<div id="namespace-636086758" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1657792697"></a>
<a href="../namespaces/CGExtensions.query.html" style="margin-left: 30px; padding-left: 0">query</a>
</div>
<div id="namespace-1657792697" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/CGExtensions.query.resultset.html">resultset</a></li>
<li class="class"><a href="../classes/CGExtensions.query.sql_resultset.html">sql_resultset</a></li>
<li class="class"><a href="../classes/CGExtensions.query.csvfileresultset.html">csvfileresultset</a></li>
<li class="class"><a href="../classes/CGExtensions.query.pagination.html">pagination</a></li>
<li class="class"><a href="../classes/CGExtensions.query.sql_query.html">sql_query</a></li>
<li class="class"><a href="../classes/CGExtensions.query.txtfileresultset.html">txtfileresultset</a></li>
<li class="class"><a href="../classes/CGExtensions.query.query.html">query</a></li>
<li class="class"><a href="../classes/CGExtensions.query.csvfilequery.html">csvfilequery</a></li>
<li class="class"><a href="../classes/CGExtensions.query.txtfilequery.html">txtfilequery</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-393199533"></a>
<a href="../namespaces/CGExtensions.reports.html" style="margin-left: 30px; padding-left: 0">reports</a>
</div>
<div id="namespace-393199533" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/CGExtensions.reports.template_report_generator.html">template_report_generator</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.html_report_generator.html">html_report_generator</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.report_defn.html">report_defn</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.tabular_report_generator.html">tabular_report_generator</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.tabular_report_defn.html">tabular_report_defn</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.tabular_report_cellfmt.html">tabular_report_cellfmt</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.tabular_report_defn_column.html">tabular_report_defn_column</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.tabular_report_defn_group.html">tabular_report_defn_group</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.tabular_report_defn_group_line.html">tabular_report_defn_group_line</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.data_report_generator.html">data_report_generator</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.text_report_generator.html">text_report_generator</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.formatted_report_generator.html">formatted_report_generator</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.report_generator.html">report_generator</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.formatted_report_defn.html">formatted_report_defn</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-945369176"></a>
<a href="../namespaces/CGExtensions.LinkDefinition.html" style="margin-left: 30px; padding-left: 0">LinkDefinition</a>
</div>
<div id="namespace-945369176" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="interface"><a href="../classes/CGExtensions.LinkDefinition.LinkDefinitionGenerator.html">LinkDefinitionGenerator</a></li>
<li class="class"><a href="../classes/CGExtensions.LinkDefinition.LinkDefinitionGeneratorFactory.html">LinkDefinitionGeneratorFactory</a></li>
<li class="class"><a href="../classes/CGExtensions.LinkDefinition.CoreLinkDefinitionGenerator.html">CoreLinkDefinitionGenerator</a></li>
<li class="class"><a href="../classes/CGExtensions.LinkDefinition.DataRef.html">DataRef</a></li>
<li class="class"><a href="../classes/CGExtensions.LinkDefinition.LinkDefinition.html">LinkDefinition</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-2140237105"></a>
<a href="../namespaces/CGExtensions.jsloader.html" style="margin-left: 30px; padding-left: 0">jsloader</a>
</div>
<div id="namespace-2140237105" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/CGExtensions.jsloader.libdefn.html">libdefn</a></li>
<li class="class"><a href="../classes/CGExtensions.jsloader.jsloader.html">jsloader</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
<li class="class"><a href="../classes/CGExtensions.content_list_builder.html">content_list_builder</a></li>
<li class="class"><a href="../classes/CGExtensions.wm_exception.html">wm_exception</a></li>
<li class="class"><a href="../classes/CGExtensions.watermarker.html">watermarker</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
<li class="class"><a href="../classes/cge_dir.html">cge_dir</a></li>
<li class="class"><a href="../classes/cge_redirect.html">cge_redirect</a></li>
<li class="class"><a href="../classes/cge_http.html">cge_http</a></li>
<li class="class"><a href="../classes/cge_singleton.html">cge_singleton</a></li>
<li class="class"><a href="../classes/cge_address.html">cge_address</a></li>
<li class="class"><a href="../classes/cge_setup.html">cge_setup</a></li>
<li class="class"><a href="../classes/cms_cache_handler.html">cms_cache_handler</a></li>
<li class="class"><a href="../classes/cge_url.html">cge_url</a></li>
<li class="class"><a href="../classes/cg_fileupload.html">cg_fileupload</a></li>
<li class="class"><a href="../classes/cge_template_admin.html">cge_template_admin</a></li>
<li class="class"><a href="../classes/cg_watermark.html">cg_watermark</a></li>
<li class="class"><a href="../classes/cge_debug.html">cge_debug</a></li>
<li class="class"><a href="../classes/CGExtensions.html">CGExtensions</a></li>
<li class="class"><a href="../classes/cg_exception.html">cg_exception</a></li>
<li class="class"><a href="../classes/cms_filecache_driver.html">cms_filecache_driver</a></li>
<li class="class"><a href="../classes/cge_cached_remote_file.html">cge_cached_remote_file</a></li>
<li class="class"><a href="../classes/friendly.html">friendly</a></li>
<li class="class"><a href="../classes/cge_utils.html">cge_utils</a></li>
<li class="class"><a href="../classes/cge_image.html">cge_image</a></li>
<li class="class"><a href="../classes/cge_browser.html">cge_browser</a></li>
<li class="class"><a href="../classes/cge_uploader.html">cge_uploader</a></li>
<li class="class"><a href="../classes/cge_tags.html">cge_tags</a></li>
<li class="class"><a href="../classes/cge_encrypt.html">cge_encrypt</a></li>
<li class="class"><a href="../classes/cge_datastore.html">cge_datastore</a></li>
<li class="class"><a href="../classes/cge_userops.html">cge_userops</a></li>
<li class="class"><a href="../classes/cge_template_utils.html">cge_template_utils</a></li>
<li class="class"><a href="../classes/cge_tmpdata.html">cge_tmpdata</a></li>
<li class="class"><a href="../classes/cge_units.html">cge_units</a></li>
<li class="class"><a href="../classes/module_helper.html">module_helper</a></li>
<li class="class"><a href="../classes/cms_cache_driver.html">cms_cache_driver</a></li>
<li class="class"><a href="../classes/cge_string.html">cge_string</a></li>
<li class="class"><a href="../classes/cge_date.html">cge_date</a></li>
<li class="class"><a href="../classes/cge_headers.html">cge_headers</a></li>
<li class="class"><a href="../classes/notification_message.html">notification_message</a></li>
<li class="class"><a href="../classes/cge_smartcache_handler.html">cge_smartcache_handler</a></li>
<li class="class"><a href="../classes/AssocDataNode.html">AssocDataNode</a></li>
<li class="class"><a href="../classes/AssocData.html">AssocData</a></li>
<li class="class"><a href="../classes/cge_message.html">cge_message</a></li>
<li class="class"><a href="../classes/encrypted_store.html">encrypted_store</a></li>
<li class="class"><a href="../classes/cg_db_exception.html">cg_db_exception</a></li>
<li class="class"><a href="../classes/cg_sql_error.html">cg_sql_error</a></li>
<li class="class"><a href="../classes/cg_InvalidDataException.html">cg_InvalidDataException</a></li>
<li class="class"><a href="../classes/cg_notfoundException.html">cg_notfoundException</a></li>
<li class="class"><a href="../classes/cge_session.html">cge_session</a></li>
<li class="class"><a href="../classes/cge_date_utils.html">cge_date_utils</a></li>
<li class="class"><a href="../classes/cge_array.html">cge_array</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
</section>
<section class="row-fluid">
<div class="span10 offset2">
<div class="row-fluid">
<div class="span8 content class">
<nav>
<a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i>
</nav>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
<h1><small>\</small>cge_string</h1>
<p><em>A set of string utility functions.</em></p>
<section id="summary">
<h2>Summary</h2>
<section class="row-fluid heading">
<section class="span4">
<a href="#methods">Methods</a>
</section>
<section class="span4">
<a href="#properties">Properties</a>
</section>
<section class="span4">
<a href="#constants">Constants</a>
</section>
</section>
<section class="row-fluid public">
<section class="span4">
<a href="../classes/cge_string.html#method_mask_string" class="">mask_string()</a><br />
<a href="../classes/cge_string.html#method_word_limiter" class="">word_limiter()</a><br />
<a href="../classes/cge_string.html#method_str_to_bytes" class="">str_to_bytes()</a><br />
</section>
<section class="span4">
<em>No public properties found</em>
</section>
<section class="span4">
<em>No constants found</em>
</section>
</section>
<section class="row-fluid protected">
<section class="span4">
<em>No protected methods found</em>
</section>
<section class="span4">
<em>No protected properties found</em>
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
<section class="row-fluid private">
<section class="span4">
<em>No private methods found</em>
</section>
<section class="span4">
<em>No private properties found</em>
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
</section>
</div>
<aside class="span4 detailsbar">
<span class="label label-info">final</span>
<dl>
<dt>File</dt>
<dd><a href="../files/lib.class.cge_string.php.html"><div class="path-wrapper">lib/class.cge_string.php</div></a></dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">\CGExtensions</div></dd>
<dt>Class hierarchy</dt>
<dd class="hierarchy">
<div class="namespace-wrapper">\cge_string</div>
</dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<a id="methods" name="methods"></a>
<div class="row-fluid">
<div class="span8 content class"><h2>Methods</h2></div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_mask_string" name="method_mask_string" class="anchor"></a>
<article class="method">
<h3 class="public ">mask_string()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">mask_string(string <span class="argument">$instr</span>, int <span class="argument">$numchars</span>, string <span class="argument">$mask</span>) : string</pre>
<p><em>A simple utility function to mask the first N characters of an input string</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$instr</td>
<td><p>The input string</p></td>
</tr>
<tr>
<td>int</td>
<td>$numchars</td>
<td><p>The number of characters to mask</p></td>
</tr>
<tr>
<td>string</td>
<td>$mask</td>
<td><p>The mask character</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<span class="label label-info">static</span>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_word_limiter" name="method_word_limiter" class="anchor"></a>
<article class="method">
<h3 class="public ">word_limiter()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">word_limiter(string <span class="argument">$str</span>, int <span class="argument">$limit</span>, string <span class="argument">$end_char</span>) : string</pre>
<p><em>Truncate the input string after N words.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$str</td>
<td><p>The input string</p></td>
</tr>
<tr>
<td>int</td>
<td>$limit</td>
<td><p>The word limit</p></td>
</tr>
<tr>
<td>string</td>
<td>$end_char</td>
<td><p>How to terminate the output string</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<span class="label label-info">static</span>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_str_to_bytes" name="method_str_to_bytes" class="anchor"></a>
<article class="method">
<h3 class="public ">str_to_bytes()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">str_to_bytes(string <span class="argument">$val</span>) : int</pre>
<p><em>Given an input string in the format of ###[GgMmKk] convert it into a byte count.</em></p>
<p>Each kilobyte is 1024 butes. Each megabyte is 1024 kilobytes. And each Gigabyte is 1024 megabytes.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$val</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
int
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<span class="label label-info">static</span>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
</div>
</section>
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
<h3 id="source-view-label">class.cge_string.php</h3>
</div>
<div class="modal-body">
<pre data-src="../files/lib/class.cge_string.php.txt" class="language-php line-numbers"></pre>
</div>
</div>
<footer class="row-fluid">
<section class="span10 offset2">
<section class="row-fluid">
<section class="span10 offset1">
<section class="row-fluid footer-sections">
<section class="span4">
<h1><i class="icon-code"></i></h1>
<div>
<ul>
<li><a href="../namespaces/CGExtensions.html">\CGExtensions</a></li>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-bar-chart"></i></h1>
<div>
<ul>
<li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-pushpin"></i></h1>
<div>
<ul>
<li><a href="../reports/errors.html">Errors</a></li>
<li><a href="../reports/markers.html">Markers</a></li>
</ul>
</div>
</section>
</section>
</section>
</section>
<section class="row-fluid">
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on January 17th, 2015 at 10:19.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>