phpdoc/Library/CommandLine/AbstractCommandLineController.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Library\CommandLine\AbstractCommandLineController | 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_AbstractCommandLineController" 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/CommandLine.html">CommandLine</a></li>
<li>AbstractCommandLineController</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>AbstractCommandLineController</h1>
</div>
<p> class
<strong>AbstractCommandLineController</strong> implements
<a href="../../Library/CommandLine/CommandLineControllerInterface.html"><abbr title="Library\CommandLine\CommandLineControllerInterface">CommandLineControllerInterface</abbr></a>
</p>
<div class="description">
<p>Basic command line controller</p> <p>Any command line controller must extend this abstract class.</p>
<p>It defines some basic command line options that you must not overwrite in your child class:</p>
<ul>
<li>"h | help" : get a usage information,</li>
<li>"v | verbose" : increase verbosity of the execution (written strings must be handled in your scripts),</li>
<li>"x | debug" : execute the script in "debug" mode (must write actions before executing them),</li>
<li>"q | quiet" : turn verbosity totally off during the execution (only errors and informations will be written),</li>
<li>"f | force" : force some actions (avoid interactions),</li>
<li>"i | interactive" : increase interactivity of the execution,</li>
<li>"version" : get some version information about running environment.</li>
</ul>
</p> </div>
<h2>Properties</h2>
<table class="table table-condensed">
<tr>
<td class="type" id="property__name">
static
string
</td>
<td>$_name</td>
<td class="last">This must be over-written in any child class</td>
<td></td>
</tr>
<tr>
<td class="type" id="property__version">
static
string
</td>
<td>$_version</td>
<td class="last">This must be over-written in any child class</td>
<td></td>
</tr>
</table>
<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___construct">__construct</a>(
array $options = array())
<p class="no-description">No description</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___toString">__toString</a>()
<p>Magic distribution when printing object</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_distribute">distribute</a>()
<p>Distribution of the work</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/CommandLine/AbstractCommandLineController.html"><abbr title="Library\CommandLine\AbstractCommandLineController">AbstractCommandLineController</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setDebug">setDebug</a>(
bool $dbg = true)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\CommandLine\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_setVerbose">setVerbose</a>(
bool $vbr = true)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\CommandLine\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_setForce">setForce</a>(
bool $frc = true)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\CommandLine\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_setInteractive">setInteractive</a>(
bool $frc = true)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\CommandLine\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_setQuiet">setQuiet</a>()
<p class="no-description">No description</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_addDoneMethod">addDoneMethod</a>(
string $_cls_meth)
<p class="no-description">No description</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 class="no-description">No description</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 class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_runHelpCommand">runHelpCommand</a>($opt = null)
<p>List of all options and features of the command line tool ; for some commands, a specific help can be available, running <var>--command --help</var>
Some command examples are purposed running <var>--console --help</var></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_runVerboseCommand">runVerboseCommand</a>()
<p>Run the command line in <bold>verbose</bold> mode, writing some information on screen (default is <option>OFF</option>)</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_runQuietCommand">runQuietCommand</a>()
<p>Run the command line in <bold>quiet</bold> mode, trying to not write anything on screen (default is <option>OFF</option>)</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_runDebugCommand">runDebugCommand</a>()
<p>Run the command line in <bold>debug</bold> mode, writing some scripts information during runtime (default is <option>OFF</option>)</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_runForceCommand">runForceCommand</a>()
<p>Run the command line in <bold>forced</bold> mode ; any choice will be set on default value if so</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_runInteractiveCommand">runInteractiveCommand</a>()
<p>Run the command line in <bold>interactive</bold> mode ; any choice will be prompted if possible</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_runVersionCommand">runVersionCommand</a>()
<p>Get versions of system environment</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\CommandLine\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_write">write</a>(
null $str = null,
bool $new_line = true)
<p>Format and write a string to STDOUT</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\CommandLine\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_error">error</a>(
null $str = null,
int $status = 1,
bool $new_line = true)
<p>Format and write an error message to STDOUT (or STDERR) and exits with status <code>$status</code></p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\CommandLine\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_parseAndWrite">parseAndWrite</a>(
string $str,
null $type = null,
bool $spaced = false)
<p>Parse, format and write a message to STDOUT</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\CommandLine\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_writeError">writeError</a>(
string $str)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\CommandLine\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_writeThinError">writeThinError</a>(
string $str)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\CommandLine\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_writeInfo">writeInfo</a>(
string $str)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\CommandLine\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_writeComment">writeComment</a>(
string $str)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\CommandLine\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_writeHighlight">writeHighlight</a>(
string $str)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\CommandLine\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_writeBreak">writeBreak</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\CommandLine\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_writeStop">writeStop</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\CommandLine\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_verboseWrite">verboseWrite</a>(
null $str = null,
bool $new_line = true)
<p>Write a string only in verbose mode</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Library\CommandLine\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_debugWrite">debugWrite</a>(
null $str = null,
bool $new_line = true)
<p>Write a string only in debug mode</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_prompt">prompt</a>(
string|null $str = null,
mixed|null $default = null)
<p>Prompt user input</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_getPrompt">getPrompt</a>()
<p>Get last user input</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_writeIntro">writeIntro</a>()
<p class="no-description">No description</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_getVersionString">getVersionString</a>()
<p class="no-description">No description</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_writeNothingToDo">writeNothingToDo</a>()
<p class="no-description">No description</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_runArgumentHelp">runArgumentHelp</a>($arg = null)
<p class="no-description">No description</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_usage">usage</a>($opt = null)
<p class="no-description">No description</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_getopt">getopt</a>()
<p class="no-description">No description</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_getOptionMethod">getOptionMethod</a>($arg = null)
<p class="no-description">No description</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_getOptionDescription">getOptionDescription</a>($arg = null)
<p class="no-description">No description</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_getOptionHelp">getOptionHelp</a>($arg = null)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
</div>
<h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method___construct">
<div class="location">at line 175</div>
<code>
<strong>__construct</strong>(
array $options = array())</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>$options</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method___toString">
<div class="location">at line 219</div>
<code>
string
<strong>__toString</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Magic distribution when printing object</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_distribute">
<div class="location">at line 228</div>
<code>
<strong>distribute</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Distribution of the work</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setDebug">
<div class="location">at line 248</div>
<code>
<a href="../../Library/CommandLine/AbstractCommandLineController.html"><abbr title="Library\CommandLine\AbstractCommandLineController">AbstractCommandLineController</abbr></a>
<strong>setDebug</strong>(
bool $dbg = true)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>$dbg</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/CommandLine/AbstractCommandLineController.html"><abbr title="Library\CommandLine\AbstractCommandLineController">AbstractCommandLineController</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setVerbose">
<div class="location">at line 259</div>
<code>
<abbr title="Library\CommandLine\$this">$this</abbr>
<strong>setVerbose</strong>(
bool $vbr = true)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>$vbr</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\CommandLine\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setForce">
<div class="location">at line 269</div>
<code>
<abbr title="Library\CommandLine\$this">$this</abbr>
<strong>setForce</strong>(
bool $frc = true)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>$frc</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\CommandLine\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setInteractive">
<div class="location">at line 279</div>
<code>
<abbr title="Library\CommandLine\$this">$this</abbr>
<strong>setInteractive</strong>(
bool $frc = true)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>$frc</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\CommandLine\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setQuiet">
<div class="location">at line 290</div>
<code>
<abbr title="Library\CommandLine\$this">$this</abbr>
<strong>setQuiet</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\CommandLine\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
<h4>See also</h4>
<table class="table table-condensed">
<tr>
<td>self::setVerbose()</td>
<td></td>
</tr>
<tr>
<td>self::setDebug()</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_addDoneMethod">
<div class="location">at line 301</div>
<code>
<strong>addDoneMethod</strong>(
string $_cls_meth)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$_cls_meth</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getDoneMethods">
<div class="location">at line 310</div>
<code>
array
<strong>getDoneMethods</strong>()</code>
</h3>
<div class="details">
<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 321</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 332</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 343</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 354</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 class="method-item">
<h3 id="method_runHelpCommand">
<div class="location">at line 368</div>
<code>
<strong>runHelpCommand</strong>($opt = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>List of all options and features of the command line tool ; for some commands, a specific help can be available, running <var>--command --help</var>
Some command examples are purposed running <var>--console --help</var></p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$opt</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_runVerboseCommand">
<div class="location">at line 391</div>
<code>
<strong>runVerboseCommand</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Run the command line in <bold>verbose</bold> mode, writing some information on screen (default is <option>OFF</option>)</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_runQuietCommand">
<div class="location">at line 399</div>
<code>
<strong>runQuietCommand</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Run the command line in <bold>quiet</bold> mode, trying to not write anything on screen (default is <option>OFF</option>)</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_runDebugCommand">
<div class="location">at line 407</div>
<code>
<strong>runDebugCommand</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Run the command line in <bold>debug</bold> mode, writing some scripts information during runtime (default is <option>OFF</option>)</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_runForceCommand">
<div class="location">at line 415</div>
<code>
<strong>runForceCommand</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Run the command line in <bold>forced</bold> mode ; any choice will be set on default value if so</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_runInteractiveCommand">
<div class="location">at line 423</div>
<code>
<strong>runInteractiveCommand</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Run the command line in <bold>interactive</bold> mode ; any choice will be prompted if possible</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_runVersionCommand">
<div class="location">at line 431</div>
<code>
<strong>runVersionCommand</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get versions of system environment</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_write">
<div class="location">at line 460</div>
<code>
<abbr title="Library\CommandLine\$this">$this</abbr>
<strong>write</strong>(
null $str = null,
bool $new_line = true)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Format and write a string to STDOUT</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
null</td>
<td>$str</td>
<td>
</td>
</tr>
<tr>
<td>
bool</td>
<td>$new_line</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\CommandLine\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_error">
<div class="location">at line 474</div>
<code>
<abbr title="Library\CommandLine\$this">$this</abbr>
<strong>error</strong>(
null $str = null,
int $status = 1,
bool $new_line = true)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Format and write an error message to STDOUT (or STDERR) and exits with status <code>$status</code></p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
null</td>
<td>$str</td>
<td>
</td>
</tr>
<tr>
<td>
int</td>
<td>$status</td>
<td>
</td>
</tr>
<tr>
<td>
bool</td>
<td>$new_line</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\CommandLine\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_parseAndWrite">
<div class="location">at line 488</div>
<code>
<abbr title="Library\CommandLine\$this">$this</abbr>
<strong>parseAndWrite</strong>(
string $str,
null $type = null,
bool $spaced = false)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Parse, format and write a message to STDOUT</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$str</td>
<td>
</td>
</tr>
<tr>
<td>
null</td>
<td>$type</td>
<td>
</td>
</tr>
<tr>
<td>
bool</td>
<td>$spaced</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\CommandLine\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_writeError">
<div class="location">at line 503</div>
<code>
<abbr title="Library\CommandLine\$this">$this</abbr>
<strong>writeError</strong>(
string $str)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$str</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\CommandLine\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_writeThinError">
<div class="location">at line 514</div>
<code>
<abbr title="Library\CommandLine\$this">$this</abbr>
<strong>writeThinError</strong>(
string $str)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$str</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\CommandLine\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_writeInfo">
<div class="location">at line 526</div>
<code>
<abbr title="Library\CommandLine\$this">$this</abbr>
<strong>writeInfo</strong>(
string $str)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$str</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\CommandLine\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_writeComment">
<div class="location">at line 536</div>
<code>
<abbr title="Library\CommandLine\$this">$this</abbr>
<strong>writeComment</strong>(
string $str)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$str</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\CommandLine\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_writeHighlight">
<div class="location">at line 547</div>
<code>
<abbr title="Library\CommandLine\$this">$this</abbr>
<strong>writeHighlight</strong>(
string $str)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$str</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\CommandLine\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_writeBreak">
<div class="location">at line 556</div>
<code>
<abbr title="Library\CommandLine\$this">$this</abbr>
<strong>writeBreak</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\CommandLine\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_writeStop">
<div class="location">at line 565</div>
<code>
<abbr title="Library\CommandLine\$this">$this</abbr>
<strong>writeStop</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\CommandLine\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_verboseWrite">
<div class="location">at line 585</div>
<code>
<abbr title="Library\CommandLine\$this">$this</abbr>
<strong>verboseWrite</strong>(
null $str = null,
bool $new_line = true)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Write a string only in verbose mode</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
null</td>
<td>$str</td>
<td>
</td>
</tr>
<tr>
<td>
bool</td>
<td>$new_line</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\CommandLine\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_debugWrite">
<div class="location">at line 598</div>
<code>
<abbr title="Library\CommandLine\$this">$this</abbr>
<strong>debugWrite</strong>(
null $str = null,
bool $new_line = true)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Write a string only in debug mode</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
null</td>
<td>$str</td>
<td>
</td>
</tr>
<tr>
<td>
bool</td>
<td>$new_line</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\CommandLine\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_prompt">
<div class="location">at line 611</div>
<code>
string
<strong>prompt</strong>(
string|null $str = null,
mixed|null $default = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Prompt user input</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string|null</td>
<td>$str</td>
<td>
</td>
</tr>
<tr>
<td>
mixed|null</td>
<td>$default</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getPrompt">
<div class="location">at line 624</div>
<code>
string
<strong>getPrompt</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get last user input</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_writeIntro">
<div class="location">at line 641</div>
<code>
<strong>writeIntro</strong>()</code>
</h3>
<div class="details">
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getVersionString">
<div class="location">at line 651</div>
<code>
<strong>getVersionString</strong>()</code>
</h3>
<div class="details">
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_writeNothingToDo">
<div class="location">at line 664</div>
<code>
<strong>writeNothingToDo</strong>()</code>
</h3>
<div class="details">
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_runArgumentHelp">
<div class="location">at line 671</div>
<code>
<strong>runArgumentHelp</strong>($arg = null)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$arg</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_usage">
<div class="location">at line 684</div>
<code>
<strong>usage</strong>($opt = null)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$opt</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getopt">
<div class="location">at line 788</div>
<code>
<strong>getopt</strong>()</code>
</h3>
<div class="details">
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getOptionMethod">
<div class="location">at line 795</div>
<code>
<strong>getOptionMethod</strong>($arg = null)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$arg</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getOptionDescription">
<div class="location">at line 802</div>
<code>
<strong>getOptionDescription</strong>($arg = null)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$arg</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getOptionHelp">
<div class="location">at line 807</div>
<code>
<strong>getOptionHelp</strong>($arg = null)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$arg</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>