docs/class-Teto.Object.TypeAssert.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Trait Teto\Object\TypeAssert | ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK</title>
<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li>
<a href="namespace-Baguette.html">
Baguette<span></span>
</a>
<ul>
<li>
<a href="namespace-Baguette.Mastodon.html">
Mastodon<span></span>
</a>
<ul>
<li class="main">
<a href="namespace-Baguette.Mastodon.Config.html">
Config </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Entity.html">
Entity </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Grant.html">
Grant </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Service.html">
Service </a>
</li>
</ul></li></ul></li>
<li>
<a href="namespace-GuzzleHttp.html">
GuzzleHttp<span></span>
</a>
<ul>
<li>
<a href="namespace-GuzzleHttp.Cookie.html">
Cookie </a>
</li>
<li>
<a href="namespace-GuzzleHttp.Exception.html">
Exception </a>
</li>
<li>
<a href="namespace-GuzzleHttp.Handler.html">
Handler </a>
</li>
<li>
<a href="namespace-GuzzleHttp.Promise.html">
Promise </a>
</li>
</ul></li>
<li>
<a href="namespace-Psr.html">
Psr<span></span>
</a>
<ul>
<li>
<a href="namespace-Psr.Http.html">
Http<span></span>
</a>
<ul>
<li>
<a href="namespace-Psr.Http.Message.html">
Message </a>
</li>
</ul></li></ul></li>
<li class="active">
<a href="namespace-Teto.html">
Teto<span></span>
</a>
<ul>
<li class="active">
<a href="namespace-Teto.Object.html">
Object </a>
</li>
</ul></li>
</ul>
</div>
<hr>
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Teto.Object.Helper.html">Helper</a></li>
<li><a href="class-Teto.Object.ObjectArray.html">ObjectArray</a></li>
<li><a href="class-Teto.Object.TypeDefinition.html">TypeDefinition</a></li>
</ul>
<h3>Interfaces</h3>
<ul>
<li><a href="class-Teto.Object.ToArrayInterface.html">ToArrayInterface</a></li>
</ul>
<h3>Traits</h3>
<ul>
<li><a href="class-Teto.Object.MethodAlias.html">MethodAlias</a></li>
<li><a href="class-Teto.Object.PrivateGetter.html">PrivateGetter</a></li>
<li><a href="class-Teto.Object.PrivateStrictGetter.html">PrivateStrictGetter</a></li>
<li><a href="class-Teto.Object.PropertyLikeMethod.html">PropertyLikeMethod</a></li>
<li><a href="class-Teto.Object.ReadOnly.html">ReadOnly</a></li>
<li class="active"><a href="class-Teto.Object.TypeAssert.html">TypeAssert</a></li>
<li><a href="class-Teto.Object.TypedProperty.html">TypedProperty</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" class="text" placeholder="Search">
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-Teto.Object.html" title="Summary of Teto\Object"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Trait TypeAssert</h1>
<div class="description">
<p>Argument type assertion methods</p>
</div>
<div>
<h4>Direct Known Users</h4>
<a href="class-Teto.Object.TypedProperty.html">Teto\Object\TypedProperty</a>
</div>
<div class="info">
<b>Namespace:</b> <a href="namespace-Teto.html">Teto</a>\<a href="namespace-Teto.Object.html">Object</a><br>
<b>Copyright:</b>
2016 Baguette HQ<br>
<b>License:</b>
<a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a><br>
<b>Author:</b>
USAMI Kenta <a href="mailto:tadsan@zonu.me">tadsan@zonu.me</a><br>
<b>Located at</b> <a href="source-class-Teto.Object.TypeAssert.html#5-131" title="Go to source code">Object/TypeAssert.php</a>
<br>
</div>
<table class="summary methods" id="methods">
<caption>Methods summary</caption>
<tr data-order="assertValue" id="_assertValue">
<td class="attributes"><code>
protected static
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_assertValue">#</a>
<code><a href="source-class-Teto.Object.TypeAssert.html#14-58" title="Go to source code">assertValue</a>( <span>string <var>$expected_type</var></span>, <span>string <var>$name</var></span>, <span>mixed <var>$value</var></span>, <span>boolean <var>$is_nullable</var></span> )</code>
<div class="description short">
<p>Assert a value is expected typed</p>
</div>
<div class="description detailed hidden">
<p>Assert a value is expected typed</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$expected_type</var></dt>
<dd></dd>
<dt><var>$name</var></dt>
<dd>Variable name (for error message)</dd>
<dt><var>$value</var></dt>
<dd>Received value</dd>
<dt><var>$is_nullable</var></dt>
<dd></dd>
</dl></div>
<h4>Throws</h4>
<div class="list">
LogicException<br>
InvalidArgumentException
</div>
</div>
</div></td>
</tr>
<tr data-order="assertInt" id="_assertInt">
<td class="attributes"><code>
protected static
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_assertInt">#</a>
<code><a href="source-class-Teto.Object.TypeAssert.html#60-72" title="Go to source code">assertInt</a>( <span>mixed <var>$value</var></span>, <span>string <var>$name</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Assert a value is integer</p>
</div>
<div class="description detailed hidden">
<p>Assert a value is integer</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$value</var></dt>
<dd>Received value</dd>
<dt><var>$name</var></dt>
<dd>Variable name (for error message)</dd>
</dl></div>
<h4>Throws</h4>
<div class="list">
InvalidArgumentException
</div>
</div>
</div></td>
</tr>
<tr data-order="assertString" id="_assertString">
<td class="attributes"><code>
protected static
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_assertString">#</a>
<code><a href="source-class-Teto.Object.TypeAssert.html#74-86" title="Go to source code">assertString</a>( <span>mixed <var>$value</var></span>, <span>string <var>$name</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Assert a value is string</p>
</div>
<div class="description detailed hidden">
<p>Assert a value is string</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$value</var></dt>
<dd>Received value</dd>
<dt><var>$name</var></dt>
<dd>Variable name (for error message)</dd>
</dl></div>
<h4>Throws</h4>
<div class="list">
InvalidArgumentException
</div>
</div>
</div></td>
</tr>
<tr data-order="assertArrayOrObject" id="_assertArrayOrObject">
<td class="attributes"><code>
protected static
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_assertArrayOrObject">#</a>
<code><a href="source-class-Teto.Object.TypeAssert.html#88-101" title="Go to source code">assertArrayOrObject</a>( <span>mixed <var>$value</var></span>, <span>string <var>$name</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Assert a value is array or array like object (that inplements ArrayAccess)</p>
</div>
<div class="description detailed hidden">
<p>Assert a value is array or array like object (that inplements ArrayAccess)</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$value</var></dt>
<dd>Received value</dd>
<dt><var>$name</var></dt>
<dd>Variable name (for error message)</dd>
</dl></div>
<h4>Throws</h4>
<div class="list">
InvalidArgumentException
</div>
<h4>See</h4>
<div class="list">
http://php.net/manual/class.arrayaccess.php<br>
</div>
</div>
</div></td>
</tr>
<tr data-order="assertInstanceOf" id="_assertInstanceOf">
<td class="attributes"><code>
protected static
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_assertInstanceOf">#</a>
<code><a href="source-class-Teto.Object.TypeAssert.html#103-116" title="Go to source code">assertInstanceOf</a>( <span>mixed <var>$value</var></span>, <span>string <var>$class</var></span>, <span>string <var>$name</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Assert a value is instance of $class</p>
</div>
<div class="description detailed hidden">
<p>Assert a value is instance of $class</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$value</var></dt>
<dd>Received value</dd>
<dt><var>$class</var></dt>
<dd>Class name</dd>
<dt><var>$name</var></dt>
<dd>Variable name (for error message)</dd>
</dl></div>
<h4>Throws</h4>
<div class="list">
InvalidArgumentException
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK API documentation generated by <a href="http://apigen.org">ApiGen</a>
</div>
</div>
</div>
<script src="resources/combined.js"></script>
<script src="elementlist.js"></script>
</body>
</html>