Location: PHPKode > projects > ArangoDB-PHP > ArangoDB-PHP-1.3.0/docs/classes/triagens.ArangoDb.Scope.html
<!DOCTYPE html><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>ArangoDB PHP client API » \triagens\ArangoDb\Scope</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<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">ArangoDB PHP client API</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/triagens.html"><i class="icon-th"></i> triagens</a></li>
<li><a>Packages</a></li>
<li><a href="../packages/triagens.html"><i class="icon-folder-open"></i> triagens</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> 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-remove-sign"></i> Errors 
                <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">9</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">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span 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></span><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>
<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___construct" title="__construct :: Initialise the scope"><span class="description">Initialise the scope</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method___destruct" title="__destruct :: Destroy the scope"><span class="description">Destroy the scope</span><pre>__destruct()</pre></a></li>
<li class="method public "><a href="#method_leave" title="leave :: Leave the scope"><span class="description">Leave the scope</span><pre>leave()</pre></a></li>
</ul>
</li>
<li class="nav-header private">» Private
                    <ul>
<li class="method private "><a href="#method___clone" title="__clone :: Clone function"><span class="description">Clone function</span><pre>__clone()</pre></a></li>
<li class="method private "><a href="#method_enter" title="enter :: Enter the scope"><span class="description">Enter the scope</span><pre>enter()</pre></a></li>
</ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties
                    <ul></ul>
</li>
<li class="nav-header private">» Private
                    <ul>
<li class="property private "><a href="#property__exitFunc" title="$_exitFunc :: Exit function (called when scope is left)"><span class="description"></span><pre>$_exitFunc</pre></a></li>
<li class="property private "><a href="#property__initFunc" title="$_initFunc :: Initialization function (called on scope entry)"><span class="description"></span><pre>$_initFunc</pre></a></li>
<li class="property private "><a href="#property__state" title="$_state :: Current scope state"><span class="description"></span><pre>$_state</pre></a></li>
<li class="property private "><a href="#property__value" title="$_value :: Value returned by call to init function"><span class="description"></span><pre>$_value</pre></a></li>
</ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants
                    <ul>
<li class="constant  "><a href="#constant_STATE_ENTERED" title="STATE_ENTERED :: Scope has been entered but not left"><span class="description">Scope has been entered but not left</span><pre>STATE_ENTERED</pre></a></li>
<li class="constant  "><a href="#constant_STATE_LEFT" title="STATE_LEFT :: Scope has been entered and left"><span class="description">Scope has been entered and left</span><pre>STATE_LEFT</pre></a></li>
<li class="constant  "><a href="#constant_STATE_NONE" title="STATE_NONE :: Scope has not been entered"><span class="description">Scope has not been entered</span><pre>STATE_NONE</pre></a></li>
</ul>
</li>
</ul>
</div>
<div class="span8">
<a id="\triagens\ArangoDb\Scope"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/triagens.html">triagens</a></li>
<li>
<span class="divider">\</span><a href="../namespaces/triagens.ArangoDb.html">ArangoDb</a>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/triagens.ArangoDb.Scope.html">Scope</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Executes a function on scope entry and executes another function
(cleanup) when the scope is exited</p>
<div class="details">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>package</th>
<td><a href="../packages/triagens.ArangoDb.html">triagens\ArangoDb</a></td>
</tr></table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>Initialise the scope</h2>
<pre>__construct(callable $initFunc, callable $exitFunc) : <a href="../classes/triagens.ArangoDb.Scope.html">\triagens\ArangoDb\Scope</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$initFunc</h4>
<code>callable</code><ul>
<li>function to be called when scope is entered</li>
</ul>
</div>
<div class="subelement argument">
<h4>$exitFunc</h4>
<code>callable</code><ul>
<li>function to be called when scope if left</li>
</ul>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/triagens.ArangoDb.Scope.html">\triagens\ArangoDb\Scope</a></code></div>
</div></div>
</div>
<a id="method___destruct"></a><div class="element clickable method public method___destruct" data-toggle="collapse" data-target=".method___destruct .collapse">
<h2>Destroy the scope</h2>
<pre>__destruct() : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"><p>This will call leave() to ensure the scope is definitely left</p></div></div></div>
</div>
<a id="method_leave"></a><div class="element clickable method public method_leave" data-toggle="collapse" data-target=".method_leave .collapse">
<h2>Leave the scope</h2>
<pre>leave() : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"><p>This will execute the exit func with the value returned by the
call to the init func.
leave() will check whether the scope has already been left to avoid
duplicate execution of the exit func.</p></div></div></div>
</div>
<a id="method___clone"></a><div class="element clickable method private method___clone" data-toggle="collapse" data-target=".method___clone .collapse">
<h2>Clone function</h2>
<pre>__clone() : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>Scopes should never be cloned so this is private</p></div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.ClientException.html">\triagens\ArangoDb\ClientException</a></code></th>
<td></td>
</tr></table>
</div></div>
</div>
<a id="method_enter"></a><div class="element clickable method private method_enter" data-toggle="collapse" data-target=".method_enter .collapse">
<h2>Enter the scope</h2>
<pre>enter() : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"><p>This will call the init func and store its result value</p></div></div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a id="property__exitFunc"> </a><div class="element clickable property private property__exitFunc" data-toggle="collapse" data-target=".property__exitFunc .collapse">
<h2></h2>
<pre>$_exitFunc : callable</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property__initFunc"> </a><div class="element clickable property private property__initFunc" data-toggle="collapse" data-target=".property__initFunc .collapse">
<h2></h2>
<pre>$_initFunc : callable</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property__state"> </a><div class="element clickable property private property__state" data-toggle="collapse" data-target=".property__state .collapse">
<h2></h2>
<pre>$_state : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property__value"> </a><div class="element clickable property private property__value" data-toggle="collapse" data-target=".property__value .collapse">
<h2></h2>
<pre>$_value : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<h3>
<i class="icon-custom icon-constant"></i> Constants</h3>
<a id="constant_STATE_ENTERED"> </a><div class="element clickable constant  constant_STATE_ENTERED" data-toggle="collapse" data-target=".constant_STATE_ENTERED .collapse">
<h2>Scope has been entered but not left</h2>
<pre>STATE_ENTERED </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_STATE_LEFT"> </a><div class="element clickable constant  constant_STATE_LEFT" data-toggle="collapse" data-target=".constant_STATE_LEFT .collapse">
<h2>Scope has been entered and left</h2>
<pre>STATE_LEFT </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_STATE_NONE"> </a><div class="element clickable constant  constant_STATE_NONE" data-toggle="collapse" data-target=".constant_STATE_NONE .collapse">
<h2>Scope has not been entered</h2>
<pre>STATE_NONE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><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 2.0.0a12</a> and<br>
            generated on 2013-05-11T17:21:43+03:00.<br></footer></div>
</div>
</body>
</html>
Return current item: ArangoDB-PHP