documentation/api/html/classes/Nectary_Command.xhtml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<title>phpDox - Nectary\Command</title>
<link rel="stylesheet" type="text/css" href="../css/style.css" media="screen"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
</head>
<body>
<nav class="topnav">
<ul>
<li>
<div class="logo"><span>/**</span>phpDox</div>
</li>
<li class="separator">
<a href="../index.xhtml">Overview</a>
</li>
<li class="separator">
<a href="../namespaces.xhtml">Namespaces</a>
</li>
<li>
<a href="../interfaces.xhtml">Interfaces</a>
</li>
<li>
<a href="../classes.xhtml">Classes</a>
</li>
<li>
<a href="../traits.xhtml">Traits</a>
</li>
<li class="separator">
<a href="../source/index.xhtml">Source</a>
</li>
</ul>
</nav>
<div id="mainstage">
<div class="box">
<ul class="breadcrumb">
<li>
<a href="../index.xhtml">Overview</a>
</li>
<li class="separator">
<a href="../classes.xhtml">Classes</a>
</li>
<li class="separator">
<a href="../classes.xhtml#Nectary">Nectary</a>
</li>
<li class="separator">Command</li>
</ul>
</div>
<nav class="box">
<ul>
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#synopsis">Synopsis</a>
</li>
<li>
<a href="#methods">Methods</a>
</li>
<li>
<a href="../source/commands/command.php.xhtml#line17">Source</a>
</li>
</ul>
</nav>
<section>
<h1 id="introduction"><small>Nectary\</small>Command</h1>
<h4>Commands are used as general task runners, specifically, they differ from services and other types of actions in that they should not communicate back to the caller.</h4>
<p>In fact, in order to ensure that a command adheres to this expectation,<br/>a utility function called `dispatch` is provided which will handle<br/>a command for you and will not return anything.<br/><br/>The `dispatch` call is also preferred to calling `handle` directly since<br/>Commands can be handled in different ways.</p>
<ul/>
<h2 id="synopsis">Synopsis</h2>
<div class="synopsis">class Command
{<br/><ul class="none"><li>// methods</li><li>public abstract void <a title="Nectary\Command" href="../classes/Nectary_Command/handle.xhtml">handle</a>()
</li></ul>
}<br/></div>
<h2 id="methods">Methods</h2>
<div class="styled">
<h4>public</h4>
<ul>
<li id="handle"><a title="Nectary\Command" href="../classes/Nectary_Command/handle.xhtml">handle()</a>
— Handle the given command</li>
</ul>
</div>
</section>
</div>
<footer>
<span>Generated using phpDox 0.8.2-dev - Copyright (C) 2010 - 2017 by Arne Blankerts</span>
</footer>
</body>
</html>