phpdoc/Library/Object/AbstractInvokable.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Library\Object\AbstractInvokable | 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_Object_AbstractInvokable" 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/Object.html">Object</a></li>
<li>AbstractInvokable</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>AbstractInvokable</h1>
</div>
<p> class
<strong>AbstractInvokable</strong> implements
<a href="../../Library/Object/InvokableInterface.html"><abbr title="Library\Object\InvokableInterface">InvokableInterface</abbr></a>
</p>
<div class="description">
<p>Magic handling of properties access</p> <p><h2>Presentation</h2>
<p>This model constructs an accessible object in which you can dynamically set and get
properties on the fly without errors.</p>
<p>The visibility of properties is kept for direct set or get.</p>
<h2>Rules</h2>
<p>All setter methods returns the object itself for chainability.</p>
<p>To use static magic caller, your constructor must not require any argument.</p> </div>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
mixed
</div>
<div class="col-md-8 type">
<a href="#method___invoke">__invoke</a>(
string $name)
<p>Magic getter when calling an object as a function</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
mixed
</div>
<div class="col-md-8 type">
<a href="#method___call">__call</a>(
string $name,
array $arguments)
<p>Magic handler when calling a non-existing method on an object</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
mixed
</div>
<div class="col-md-8 type">
<a href="#method___callStatic">__callStatic</a>(
string $name,
array $arguments)
<p>Magic handler when calling a non-eixsting method statically on an object</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
mixed
</div>
<div class="col-md-8 type">
<a href="#method___get">__get</a>(
string $name)
<p>Magic getter</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/Object/InvokableInterface.html"><abbr title="Library\Object\InvokableInterface">InvokableInterface</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method___set">__set</a>(
string $name,
mixed $value)
<p>Magic setter</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method___isset">__isset</a>(
string $name)
<p>Magic checker</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/Object/InvokableInterface.html"><abbr title="Library\Object\InvokableInterface">InvokableInterface</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method___unset">__unset</a>(
string $name)
<p>Magic unsetter</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_findPropertyName">findPropertyName</a>(
string $name)
<p>Search a property name in the current object with one or tow leading underscores</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_findPropertyNameStatic">findPropertyNameStatic</a>(
string $name,
string|object $object)
<p>Search a property name in the current object with one or tow leading underscores</p> </div>
<div class="col-md-2"></div>
</div>
</div>
<h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method___invoke">
<div class="location">at line 68</div>
<code>
mixed
<strong>__invoke</strong>(
string $name)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Magic getter when calling an object as a function</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>The property name called on the object</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>This will return the result of the magic getter, or nothing if nothing can be done</td>
</tr>
</table>
<h4>See also</h4>
<table class="table table-condensed">
<tr>
<td><http://www.php.net/manual/en/language.oop5.magic.php></td>
<td></td>
</tr>
<tr>
<td>Library\Object\AbstractInvokable::_invokeGet()</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method___call">
<div class="location">at line 96</div>
<code>
mixed
<strong>__call</strong>(
string $name,
array $arguments)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Magic handler when calling a non-existing method on an object</p> <p>Magic method handling <code>getProp(default)</code>, <code>setProp(value)</code>, <code>unsetProp()</code>, <code>issetProp()</code> or <code>resetProp()</code>.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>The non-existing method name called on the object</td>
</tr>
<tr>
<td>
array</td>
<td>$arguments</td>
<td>The arguments array passed calling the method</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>Must return the result of a magic method, or nothing if nothing can be done</td>
</tr>
</table>
<h4>See also</h4>
<table class="table table-condensed">
<tr>
<td><http://www.php.net/manual/en/language.oop5.overloading.php></td>
<td></td>
</tr>
<tr>
<td>Library\Object\AbstractInvokable::_invokeIsset()</td>
<td></td>
</tr>
<tr>
<td>Library\Object\AbstractInvokable::_invokeReset()</td>
<td></td>
</tr>
<tr>
<td>Library\Object\AbstractInvokable::_invokeUnset()</td>
<td></td>
</tr>
<tr>
<td>Library\Object\AbstractInvokable::_invokeSet()</td>
<td></td>
</tr>
<tr>
<td>Library\Object\AbstractInvokable::_invokeGet()</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method___callStatic">
<div class="location">at line 141</div>
<code> static
mixed
<strong>__callStatic</strong>(
string $name,
array $arguments)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Magic handler when calling a non-eixsting method statically on an object</p> <p>Magic static handling of <code>getProp(default)</code>, <code>setProp(value)</code>, <code>unsetProp()</code>, <code>issetProp()</code> or <code>resetProp()</code>.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>The non-existing method name called on the object</td>
</tr>
<tr>
<td>
array</td>
<td>$arguments</td>
<td>The arguments array passed calling the method</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>Must return the result of a magic method, or nothing if nothing can be done</td>
</tr>
</table>
<h4>See also</h4>
<table class="table table-condensed">
<tr>
<td><http://www.php.net/manual/en/language.oop5.overloading.php></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method___get">
<div class="location">at line 176</div>
<code>
mixed
<strong>__get</strong>(
string $name)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Magic getter</p> <p>Magic method called when <code>$this->prop</code> is invoked.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>The name of the property to get</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>This will return the result of a magic method, or nothing if nothing can be done</td>
</tr>
</table>
<h4>See also</h4>
<table class="table table-condensed">
<tr>
<td><http://www.php.net/manual/en/language.oop5.overloading.php></td>
<td></td>
</tr>
<tr>
<td>Library\Object\AbstractInvokable::_invokeGet()</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method___set">
<div class="location">at line 193</div>
<code>
<a href="../../Library/Object/InvokableInterface.html"><abbr title="Library\Object\InvokableInterface">InvokableInterface</abbr></a>
<strong>__set</strong>(
string $name,
mixed $value)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Magic setter</p> <p>Magic method called when <code>$this->arg = value</code> is invoked.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>The name of the property to get</td>
</tr>
<tr>
<td>
mixed</td>
<td>$value</td>
<td>The value to set for the property</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/Object/InvokableInterface.html"><abbr title="Library\Object\InvokableInterface">InvokableInterface</abbr></a></td>
<td>Returns <code>$this</code> for method chaining</td>
</tr>
</table>
<h4>See also</h4>
<table class="table table-condensed">
<tr>
<td><http://www.php.net/manual/en/language.oop5.overloading.php></td>
<td></td>
</tr>
<tr>
<td>Library\Object\AbstractInvokable::_invokeSet()</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method___isset">
<div class="location">at line 209</div>
<code>
bool
<strong>__isset</strong>(
string $name)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Magic checker</p> <p>Magic method called when <code>isset($this->prop)</code> or <code>empty($this->prop)</code> are invoked.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>The name of the property to get</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>This will return <code>true</code> if the property exists, <code>false</code> otherwise</td>
</tr>
</table>
<h4>See also</h4>
<table class="table table-condensed">
<tr>
<td><http://www.php.net/manual/en/language.oop5.overloading.php></td>
<td></td>
</tr>
<tr>
<td>Library\Object\AbstractInvokable::_invokeIsset()</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method___unset">
<div class="location">at line 225</div>
<code>
<a href="../../Library/Object/InvokableInterface.html"><abbr title="Library\Object\InvokableInterface">InvokableInterface</abbr></a>
<strong>__unset</strong>(
string $name)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Magic unsetter</p> <p>Magic method called when <code>unset($this->prop)</code> is invoked.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>The name of the property to get</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/Object/InvokableInterface.html"><abbr title="Library\Object\InvokableInterface">InvokableInterface</abbr></a></td>
<td>Returns <code>$this</code> for method chaining</td>
</tr>
</table>
<h4>See also</h4>
<table class="table table-condensed">
<tr>
<td><http://www.php.net/manual/en/language.oop5.overloading.php></td>
<td></td>
</tr>
<tr>
<td>Library\Object\AbstractInvokable::_invokeUnset()</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_findPropertyName">
<div class="location">at line 415</div>
<code>
string
<strong>findPropertyName</strong>(
string $name)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Search a property name in the current object with one or tow leading underscores</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>The property name to transform</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>The transformed property name</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_findPropertyNameStatic">
<div class="location">at line 427</div>
<code> static
string
<strong>findPropertyNameStatic</strong>(
string $name,
string|object $object)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Search a property name in the current object with one or tow leading underscores</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>The property name to transform</td>
</tr>
<tr>
<td>
string|object</td>
<td>$object</td>
<td>The object or a class name to work on</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>The transformed property name</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>