phpdoc/Library/CommandLine/CommandLineControllerInterface.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Library\CommandLine\CommandLineControllerInterface | 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_CommandLine_CommandLineControllerInterface" 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">interface</span></li>
<li><a href="../../Library.html">Library</a></li>
<li><a href="../../Library/CommandLine.html">CommandLine</a></li>
<li>CommandLineControllerInterface</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>CommandLineControllerInterface</h1>
</div>
<p> interface
<strong>CommandLineControllerInterface</strong>
</p>
<div class="description">
<p>CommandLine controller interface</p> </div>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_addDoneMethod">addDoneMethod</a>(
string $method_name)
<p>Adding a method in the collection of done methods</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
array
</div>
<div class="col-md-8 type">
<a href="#method_getDoneMethods">getDoneMethods</a>()
<p>Get the collection of done methods</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_setScript">setScript</a>(
string $script_name)
<p>Set the current command line script called</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string|null
</div>
<div class="col-md-8 type">
<a href="#method_getScript">getScript</a>()
<p>Get the current command line script called</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_setParameters">setParameters</a>(
array $params)
<p>Set the command line parameters</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
array
</div>
<div class="col-md-8 type">
<a href="#method_getParameters">getParameters</a>()
<p>Get the parameters collection</p> </div>
<div class="col-md-2"></div>
</div>
</div>
<h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method_addDoneMethod">
<div class="location">at line 38</div>
<code>
<strong>addDoneMethod</strong>(
string $method_name)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Adding a method in the collection of done methods</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$method_name</td>
<td>The name of the method</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getDoneMethods">
<div class="location">at line 44</div>
<code>
array
<strong>getDoneMethods</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the collection of done methods</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setScript">
<div class="location">at line 50</div>
<code>
<strong>setScript</strong>(
string $script_name)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set the current command line script called</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$script_name</td>
<td>The script name</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getScript">
<div class="location">at line 56</div>
<code>
string|null
<strong>getScript</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the current command line script called</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string|null</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setParameters">
<div class="location">at line 62</div>
<code>
<strong>setParameters</strong>(
array $params)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set the command line parameters</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>$params</td>
<td>The collection of parameters</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getParameters">
<div class="location">at line 68</div>
<code>
array
<strong>getParameters</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the parameters collection</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>
</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>