phpdoc/Library/CommandLine/Helper.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Library\CommandLine\Helper | 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_Helper" 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>Helper</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>Helper</h1>
</div>
<p> class
<strong>Helper</strong>
</p>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
static
</div>
<div class="col-md-8 type">
<a href="#method_getopt">getopt</a>(
array $options)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
</div>
<div class="col-md-8 type">
<a href="#method_getOptionMethod">getOptionMethod</a>(
array $options, $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">
static
</div>
<div class="col-md-8 type">
<a href="#method_getOptionDescription">getOptionDescription</a>($arg, $caller)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
</div>
<div class="col-md-8 type">
<a href="#method_treatOptions">treatOptions</a>(
array $options, $caller)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
</div>
<div class="col-md-8 type">
<a href="#method_getOptionHelp">getOptionHelp</a>($arg, $caller)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
</div>
<div class="col-md-8 type">
<a href="#method_getHelpInfo">getHelpInfo</a>(
array $options = array(),
<abbr title="Library\CommandLine\Library\CommandLine\Formater">Formater</abbr> $formater, $caller)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
</div>
<div class="col-md-8 type">
<a href="#method_formatHelpString">formatHelpString</a>($title = null, $contents = null,
<abbr title="Library\CommandLine\Library\CommandLine\Formater">Formater</abbr> $formater)
<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_getopt">
<div class="location">at line 37</div>
<code> static
<strong>getopt</strong>(
array $options)</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_getOptionMethod">
<div class="location">at line 54</div>
<code> static
<strong>getOptionMethod</strong>(
array $options, $arg = null)</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>
<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 67</div>
<code> static
<strong>getOptionDescription</strong>($arg, $caller)</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>
<tr>
<td></td>
<td>$caller</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_treatOptions">
<div class="location">at line 88</div>
<code> static
<strong>treatOptions</strong>(
array $options, $caller)</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>
<tr>
<td></td>
<td>$caller</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getOptionHelp">
<div class="location">at line 114</div>
<code> static
<strong>getOptionHelp</strong>($arg, $caller)</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>
<tr>
<td></td>
<td>$caller</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getHelpInfo">
<div class="location">at line 137</div>
<code> static
<strong>getHelpInfo</strong>(
array $options = array(),
<abbr title="Library\CommandLine\Library\CommandLine\Formater">Formater</abbr> $formater, $caller)</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>
<tr>
<td>
<abbr title="Library\CommandLine\Library\CommandLine\Formater">Formater</abbr></td>
<td>$formater</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$caller</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_formatHelpString">
<div class="location">at line 227</div>
<code> static
<strong>formatHelpString</strong>($title = null, $contents = null,
<abbr title="Library\CommandLine\Library\CommandLine\Formater">Formater</abbr> $formater)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$title</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$contents</td>
<td>
</td>
</tr>
<tr>
<td>
<abbr title="Library\CommandLine\Library\CommandLine\Formater">Formater</abbr></td>
<td>$formater</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>