docu_system/classes/SYSTEM.API.verify.html
2017-07-25 11:40:54 +02:00

654 lines
40 KiB
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> SYSTEM - PHP Framework &raquo; \SYSTEM\API\verify
</title>
<meta name="author" content=""/>
<meta name="description" content=""/>
<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="../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">SYSTEM - PHP Framework</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>Namespaces</a></li>
<li><a href="../namespaces/SYSTEM.html">SYSTEM</a></li>
<li><a href="../namespaces/LIB.html">LIB</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>&#160;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-list-alt"></i>&#160;Errors
</a>
</li>
<li>
<a href="../markers.html">
<i class="icon-list-alt"></i>&#160;Markers
</a>
</li>
<li>
<a href="../deprecated.html">
<i class="icon-list-alt"></i>&#160;Deprecated
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="go_to_top">
<a href="#___" style="color: inherit">Back to top&#160;&#160;<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>
<style>
.deprecated h2 {
text-decoration: line-through;
}
</style>
<div class="row">
<div class="span4">
<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>
<div 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>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods
<ul>
<li class="method public">
<a href="#method_ALL" title="ALL :: Verify All - everything is allowed">
<span class="description">Verify All - everything is allowed</span><pre>ALL</pre>
</a>
</li>
<li class="method public">
<a href="#method_ARY" title="ARY :: Verify ARY - array check">
<span class="description">Verify ARY - array check</span><pre>ARY</pre>
</a>
</li>
<li class="method public">
<a href="#method_BOOL" title="BOOL :: Verify BOOL - allow booleans">
<span class="description">Verify BOOL - allow booleans</span><pre>BOOL</pre>
</a>
</li>
<li class="method public">
<a href="#method_DATE" title="DATE :: Verify DATE - string parseable as date">
<span class="description">Verify DATE - string parseable as date</span><pre>DATE</pre>
</a>
</li>
<li class="method public">
<a href="#method_EMAIL" title="EMAIL :: Verify EMAIL - verify email">
<span class="description">Verify EMAIL - verify email</span><pre>EMAIL</pre>
</a>
</li>
<li class="method public">
<a href="#method_FLOAT" title="FLOAT :: Verify FLOAT - every float value">
<span class="description">Verify FLOAT - every float value</span><pre>FLOAT</pre>
</a>
</li>
<li class="method public">
<a href="#method_INT" title="INT :: Verify INT - all integers">
<span class="description">Verify INT - all integers</span><pre>INT</pre>
</a>
</li>
<li class="method public">
<a href="#method_JSON" title="JSON :: Verify JSON - JSON format check">
<span class="description">Verify JSON - JSON format check</span><pre>JSON</pre>
</a>
</li>
<li class="method public">
<a href="#method_LANG" title="LANG :: Verify LANG - verify supported languages">
<span class="description">Verify LANG - verify supported languages</span><pre>LANG</pre>
</a>
</li>
<li class="method public">
<a href="#method_RESULT" title="RESULT :: Verify RESULT - verify possible resulttypes">
<span class="description">Verify RESULT - verify possible resulttypes</span><pre>RESULT</pre>
</a>
</li>
<li class="method public">
<a href="#method_STRING" title="STRING :: Verify STRING - allow every string - thats all">
<span class="description">Verify STRING - allow every string - thats all</span><pre>STRING</pre>
</a>
</li>
<li class="method public">
<a href="#method_TIMEUNIX" title="TIMEUNIX :: Verify TIMEUNIX - unixtimestamp number">
<span class="description">Verify TIMEUNIX - unixtimestamp number</span><pre>TIMEUNIX</pre>
</a>
</li>
<li class="method public">
<a href="#method_UINT" title="UINT :: Verify UINT - Positive Integer excluding 0">
<span class="description">Verify UINT - Positive Integer excluding 0</span><pre>UINT</pre>
</a>
</li>
<li class="method public">
<a href="#method_UINT0" title="UINT0 :: Verify UINT0 - Positive Integer including 0">
<span class="description">Verify UINT0 - Positive Integer including 0</span><pre>UINT0</pre>
</a>
</li>
</ul>
</li>
<li class="nav-header protected">» Protected
<ul>
</ul>
</li>
<li class="nav-header private">» Private
<ul>
</ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants
<ul>
</ul>
</li>
</ul>
</div>
<div class="span8">
<div class="element class">
<h1>verify</h1>
<small style="display: block; text-align: right">
</small>
<p class="short_description">API default verify Class for Parameter validation</p>
<div class="details">
<div class="long_description">
</div>
<table class="table table-bordered">
<tr>
<th>
package
</th>
<td>
<p>SYSTEM\API</p>
</td>
</tr>
</table>
<h3><i class="icon-custom icon-method"></i> Methods</h3>
<a id="method_ALL"></a>
<div class="element clickable method public method_ALL" data-toggle="collapse" data-target=".method_ALL .collapse">
<h2>Verify All - everything is allowed</h2>
<pre>ALL(mixed $param) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$param</h4>
<code>mixed</code><p><p>Input Paramter</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns boolean if the Value matches the type</p></p>
</div>
</div>
</div>
<a id="method_ARY"></a>
<div class="element clickable method public method_ARY" data-toggle="collapse" data-target=".method_ARY .collapse">
<h2>Verify ARY - array check</h2>
<pre>ARY(mixed $param) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$param</h4>
<code>mixed</code><p><p>Input Paramter</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns boolean if the Value matches the type</p></p>
</div>
</div>
</div>
<a id="method_BOOL"></a>
<div class="element clickable method public method_BOOL" data-toggle="collapse" data-target=".method_BOOL .collapse">
<h2>Verify BOOL - allow booleans</h2>
<pre>BOOL(mixed $param) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$param</h4>
<code>mixed</code><p><p>Input Paramter</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns boolean if the Value matches the type</p></p>
</div>
</div>
</div>
<a id="method_DATE"></a>
<div class="element clickable method public method_DATE" data-toggle="collapse" data-target=".method_DATE .collapse">
<h2>Verify DATE - string parseable as date</h2>
<pre>DATE(mixed $param) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$param</h4>
<code>mixed</code><p><p>Input Paramter</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns boolean if the Value matches the type</p></p>
</div>
</div>
</div>
<a id="method_EMAIL"></a>
<div class="element clickable method public method_EMAIL" data-toggle="collapse" data-target=".method_EMAIL .collapse">
<h2>Verify EMAIL - verify email</h2>
<pre>EMAIL(mixed $param) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$param</h4>
<code>mixed</code><p><p>Input Paramter</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns boolean if the Value matches the type</p></p>
</div>
</div>
</div>
<a id="method_FLOAT"></a>
<div class="element clickable method public method_FLOAT" data-toggle="collapse" data-target=".method_FLOAT .collapse">
<h2>Verify FLOAT - every float value</h2>
<pre>FLOAT(mixed $param) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$param</h4>
<code>mixed</code><p><p>Input Paramter</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns boolean if the Value matches the type</p></p>
</div>
</div>
</div>
<a id="method_INT"></a>
<div class="element clickable method public method_INT" data-toggle="collapse" data-target=".method_INT .collapse">
<h2>Verify INT - all integers</h2>
<pre>INT(mixed $param) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$param</h4>
<code>mixed</code><p><p>Input Paramter</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns boolean if the Value matches the type</p></p>
</div>
</div>
</div>
<a id="method_JSON"></a>
<div class="element clickable method public method_JSON" data-toggle="collapse" data-target=".method_JSON .collapse">
<h2>Verify JSON - JSON format check</h2>
<pre>JSON(mixed $param) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$param</h4>
<code>mixed</code><p><p>Input Paramter</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns boolean if the Value matches the type</p></p>
</div>
</div>
</div>
<a id="method_LANG"></a>
<div class="element clickable method public method_LANG" data-toggle="collapse" data-target=".method_LANG .collapse">
<h2>Verify LANG - verify supported languages</h2>
<pre>LANG(mixed $param) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$param</h4>
<code>mixed</code><p><p>Input Paramter</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns boolean if the Value matches the type</p></p>
</div>
</div>
</div>
<a id="method_RESULT"></a>
<div class="element clickable method public method_RESULT" data-toggle="collapse" data-target=".method_RESULT .collapse">
<h2>Verify RESULT - verify possible resulttypes</h2>
<pre>RESULT(mixed $param) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$param</h4>
<code>mixed</code><p><p>Input Paramter</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns boolean if the Value matches the type</p></p>
</div>
</div>
</div>
<a id="method_STRING"></a>
<div class="element clickable method public method_STRING" data-toggle="collapse" data-target=".method_STRING .collapse">
<h2>Verify STRING - allow every string - thats all</h2>
<pre>STRING(mixed $param) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$param</h4>
<code>mixed</code><p><p>Input Paramter</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns boolean if the Value matches the type</p></p>
</div>
</div>
</div>
<a id="method_TIMEUNIX"></a>
<div class="element clickable method public method_TIMEUNIX" data-toggle="collapse" data-target=".method_TIMEUNIX .collapse">
<h2>Verify TIMEUNIX - unixtimestamp number</h2>
<pre>TIMEUNIX(mixed $param) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$param</h4>
<code>mixed</code><p><p>Input Paramter</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns boolean if the Value matches the type</p></p>
</div>
</div>
</div>
<a id="method_UINT"></a>
<div class="element clickable method public method_UINT" data-toggle="collapse" data-target=".method_UINT .collapse">
<h2>Verify UINT - Positive Integer excluding 0</h2>
<pre>UINT(mixed $param) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$param</h4>
<code>mixed</code><p><p>Input Paramter</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns boolean if the Value matches the type</p></p>
</div>
</div>
</div>
<a id="method_UINT0"></a>
<div class="element clickable method public method_UINT0" data-toggle="collapse" data-target=".method_UINT0 .collapse">
<h2>Verify UINT0 - Positive Integer including 0</h2>
<pre>UINT0(mixed $param) : boolean</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>$param</h4>
<code>mixed</code><p><p>Input Paramter</p></p>
</div>
<h3>Response</h3>
<code>boolean</code><p><p>Returns boolean if the Value matches the type</p></p>
</div>
</div>
</div>
</div>
</div>
<a id="\SYSTEM\API\verify"></a>
<ul class="breadcrumb">
<li><a href="../index.html"><i class="icon-custom icon-class"></i></a></li>
<li><span class="divider">\</span><a href="../namespaces/SYSTEM.API.html">API</a></li>
<li class="active"><span class="divider">\</span><a href="../classes/SYSTEM.API.verify.html">verify</a></li>
</ul>
</div>
</div>
</div>
<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 </a> and<br/>
generated on Tue, 25 Jul 2017 11:33:09 +0200.<br/>
</footer>
</body>
</html>