phpdoc/Library/StaticConfiguration/Config.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Library\StaticConfiguration\Config | 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_StaticConfiguration_Config" 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/StaticConfiguration.html">StaticConfiguration</a></li>
<li>Config</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>Config</h1>
</div>
<p> class
<strong>Config</strong>
</p>
<div class="description">
<p>Static global configuration object manager</p> </div>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
static
void
</div>
<div class="col-md-8 type">
<a href="#method_load">load</a>(
string $class_name = 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
bool
</div>
<div class="col-md-8 type">
<a href="#method_loaded">loaded</a>()
<p>Check if the configurator is loaded</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
void
</div>
<div class="col-md-8 type">
<a href="#method_setConfigurator">setConfigurator</a>(
<abbr title="Library\StaticConfiguration\Library\StaticConfiguration\ConfiguratorInterface">ConfiguratorInterface</abbr> $object)
<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
array
</div>
<div class="col-md-8 type">
<a href="#method_getConfigurator">getConfigurator</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">
static
void
</div>
<div class="col-md-8 type">
<a href="#method_setRegistry">setRegistry</a>(
array $registry)
<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
array
</div>
<div class="col-md-8 type">
<a href="#method_getRegistry">getRegistry</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">
static
array
</div>
<div class="col-md-8 type">
<a href="#method_getDefaults">getDefaults</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">
static
array
</div>
<div class="col-md-8 type">
<a href="#method_getRequired">getRequired</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">
static
string
</div>
<div class="col-md-8 type">
<a href="#method_getInternal">getInternal</a>(
string $name)
<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
bool
</div>
<div class="col-md-8 type">
<a href="#method_validate">validate</a>(
array $entries)
<p>Check if a custom Config class defines all required values</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
void
</div>
<div class="col-md-8 type">
<a href="#method_overload">overload</a>(
array $settings)
<p>Overload a config registry</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
void
</div>
<div class="col-md-8 type">
<a href="#method_set">set</a>(
string $name,
mixed $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">
static
mixed
</div>
<div class="col-md-8 type">
<a href="#method_get">get</a>(
string $name,
mixed $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">
static
mixed
</div>
<div class="col-md-8 type">
<a href="#method_getDefault">getDefault</a>(
string $name)
<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_load">
<div class="location">at line 62</div>
<code> static
void
<strong>load</strong>(
string $class_name = null)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$class_name</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td>
</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><a target="_blank" href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
<td>if no <code>$class_name</code> is defined for the first call</td>
</tr>
<tr>
<td><a target="_blank" href="http://php.net/DomainException"><abbr title="DomainException">DomainException</abbr></a></td>
<td>if class <code>$class_name</code> doesn't implement the ConfiguratorInterface</td>
</tr>
<tr>
<td><a target="_blank" href="http://php.net/DomainException"><abbr title="DomainException">DomainException</abbr></a></td>
<td>if class <code>$class_name</code> doesn't exist</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_loaded">
<div class="location">at line 107</div>
<code> static
bool
<strong>loaded</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Check if the configurator is loaded</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setConfigurator">
<div class="location">at line 117</div>
<code> static
void
<strong>setConfigurator</strong>(
<abbr title="Library\StaticConfiguration\Library\StaticConfiguration\ConfiguratorInterface">ConfiguratorInterface</abbr> $object)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Library\StaticConfiguration\Library\StaticConfiguration\ConfiguratorInterface">ConfiguratorInterface</abbr></td>
<td>$object</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td>
</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><a target="_blank" href="http://php.net/Exception"><abbr title="Exception">Exception</abbr></a></td>
<td>if the config class do not define all required values</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getConfigurator">
<div class="location">at line 134</div>
<code> static
array
<strong>getConfigurator</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_setRegistry">
<div class="location">at line 143</div>
<code> static
void
<strong>setRegistry</strong>(
array $registry)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>$registry</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getRegistry">
<div class="location">at line 151</div>
<code> static
array
<strong>getRegistry</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_getDefaults">
<div class="location">at line 159</div>
<code> static
array
<strong>getDefaults</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_getRequired">
<div class="location">at line 167</div>
<code> static
array
<strong>getRequired</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_getInternal">
<div class="location">at line 176</div>
<code> static
string
<strong>getInternal</strong>(
string $name)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</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_validate">
<div class="location">at line 189</div>
<code> static
bool
<strong>validate</strong>(
array $entries)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Check if a custom Config class defines all required values</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>$entries</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_overload">
<div class="location">at line 207</div>
<code> static
void
<strong>overload</strong>(
array $settings)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Overload a config registry</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>$settings</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_set">
<div class="location">at line 220</div>
<code> static
void
<strong>set</strong>(
string $name,
mixed $value)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>
</td>
</tr>
<tr>
<td>
mixed</td>
<td>$value</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_get">
<div class="location">at line 233</div>
<code> static
mixed
<strong>get</strong>(
string $name,
mixed $default = null)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>
</td>
</tr>
<tr>
<td>
mixed</td>
<td>$default</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getDefault">
<div class="location">at line 246</div>
<code> static
mixed
<strong>getDefault</strong>(
string $name)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</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>