phpdoc/Library/CommandLine/Formater.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Library\CommandLine\Formater | 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_Formater" 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>Formater</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>Formater</h1>
</div>
<p> class
<strong>Formater</strong>
</p>
<h2>Constants</h2>
<table class="table table-condensed">
<tr>
<td>FORMAT_PATTERN</td>
<td class="last">
<p><em>Mask used to identify a formated tag string like '<bold>string</bold>'</em></p>
<p>
</p>
</td>
</tr>
</table>
<h2>Properties</h2>
<table class="table table-condensed">
<tr>
<td class="type" id="property_messages">
</td>
<td>$messages</td>
<td class="last">Written messages</td>
<td></td>
</tr>
<tr>
<td class="type" id="property_tab">
static
</td>
<td>$tab</td>
<td class="last">Tabulation alias</td>
<td></td>
</tr>
<tr>
<td class="type" id="property_nl">
static
</td>
<td>$nl</td>
<td class="last">New line alias</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">
</div>
<div class="col-md-8 type">
<a href="#method___toString">__toString</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___destruct">__destruct</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_addOption">addOption</a>($option_name, $option_value)
<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_setAutospaced">setAutospaced</a>($autospaced = 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_setForegroundColor">setForegroundColor</a>($foreground = 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_setBackgroundColor">setBackgroundColor</a>($background = 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_setTextOption">setTextOption</a>($option = 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_setMessage">setMessage</a>($text = null, $foreground = null, $background = null, $option = 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_newLine">newLine</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_message">message</a>($text = null, $foreground = null, $background = null, $option = 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_prompt">prompt</a>($text = null, $default = 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_buildTaggedString">buildTaggedString</a>($str, $type = 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_parse">parse</a>($message)
<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_spacedStr">spacedStr</a>($str, $type = null, $newLines = false)
<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_format">format</a>($text = null, $foreground = null, $background = null, $option = 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_fetch">fetch</a>($display = true, $exit = false, $last_nl = true)
<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 173</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 182</div>
<code>
<strong>__toString</strong>()</code>
</h3>
<div class="details">
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method___destruct">
<div class="location">at line 187</div>
<code>
<strong>__destruct</strong>()</code>
</h3>
<div class="details">
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_addOption">
<div class="location">at line 193</div>
<code>
<strong>addOption</strong>($option_name, $option_value)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$option_name</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$option_value</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setAutospaced">
<div class="location">at line 204</div>
<code>
<strong>setAutospaced</strong>($autospaced = null)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$autospaced</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setForegroundColor">
<div class="location">at line 209</div>
<code>
<strong>setForegroundColor</strong>($foreground = null)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$foreground</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setBackgroundColor">
<div class="location">at line 216</div>
<code>
<strong>setBackgroundColor</strong>($background = null)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$background</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setTextOption">
<div class="location">at line 223</div>
<code>
<strong>setTextOption</strong>($option = null)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$option</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setMessage">
<div class="location">at line 230</div>
<code>
<strong>setMessage</strong>($text = null, $foreground = null, $background = null, $option = null)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$text</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$foreground</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$background</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$option</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_newLine">
<div class="location">at line 235</div>
<code>
<strong>newLine</strong>()</code>
</h3>
<div class="details">
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_message">
<div class="location">at line 244</div>
<code>
<strong>message</strong>($text = null, $foreground = null, $background = null, $option = null)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$text</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$foreground</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$background</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$option</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_prompt">
<div class="location">at line 249</div>
<code>
<strong>prompt</strong>($text = null, $default = null)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$text</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$default</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_buildTaggedString">
<div class="location">at line 262</div>
<code>
<strong>buildTaggedString</strong>($str, $type = null)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$str</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$type</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_parse">
<div class="location">at line 267</div>
<code>
<strong>parse</strong>($message)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$message</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_spacedStr">
<div class="location">at line 292</div>
<code>
<strong>spacedStr</strong>($str, $type = null, $newLines = false)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$str</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$type</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$newLines</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_format">
<div class="location">at line 307</div>
<code>
<strong>format</strong>($text = null, $foreground = null, $background = null, $option = null)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$text</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$foreground</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$background</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$option</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_fetch">
<div class="location">at line 341</div>
<code>
<strong>fetch</strong>($display = true, $exit = false, $last_nl = true)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$display</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$exit</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$last_nl</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>