phpdoc/Library/FactoryInterface.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Library\FactoryInterface | 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_FactoryInterface" 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>FactoryInterface</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>FactoryInterface</h1>
</div>
<p> interface
<strong>FactoryInterface</strong>
</p>
<h2>Constants</h2>
<table class="table table-condensed">
<tr>
<td>GRACEFULLY_FAILURE</td>
<td class="last">
<p><em>Constant to use to not throw error if a class is not found or doesn't implement or extend some requirements</em></p>
<p>
</p>
</td>
</tr>
<tr>
<td>ERROR_ON_FAILURE</td>
<td class="last">
<p><em>Constant to use to throw an error if a class is not found or doesn't implement or extend some requirements</em></p>
<p>
</p>
</td>
</tr>
</table>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
object
</div>
<div class="col-md-8 type">
<a href="#method_build">build</a>(
string $name,
array $parameters = null,
int $flag = self::ERROR_ON_FAILURE,
array $logs = array())
<p>Build the object instance following current factory settings</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
null|string
</div>
<div class="col-md-8 type">
<a href="#method_findBuilder">findBuilder</a>(
string $name,
int $flag = self::ERROR_ON_FAILURE,
array $logs = array())
<p>Find the object builder class following current factory settings</p> </div>
<div class="col-md-2"></div>
</div>
</div>
<h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method_build">
<div class="location">at line 54</div>
<code>
object
<strong>build</strong>(
string $name,
array $parameters = null,
int $flag = self::ERROR_ON_FAILURE,
array $logs = array())</code>
</h3>
<div class="details">
<div class="method-description">
<p>Build the object instance following current factory settings</p> <p>Errors are thrown by default but can be "gracefully" skipped using the flag <code>GRACEFULLY_FAILURE</code>.
In all cases, error messages are loaded in final parameter <code>$logs</code> passed by reference.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>
</td>
</tr>
<tr>
<td>
array</td>
<td>$parameters</td>
<td>
</td>
</tr>
<tr>
<td>
int</td>
<td>$flag</td>
<td>One of the class constants flags</td>
</tr>
<tr>
<td>
array</td>
<td>$logs</td>
<td>Passed by reference</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
object</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_findBuilder">
<div class="location">at line 67</div>
<code>
null|string
<strong>findBuilder</strong>(
string $name,
int $flag = self::ERROR_ON_FAILURE,
array $logs = array())</code>
</h3>
<div class="details">
<div class="method-description">
<p>Find the object builder class following current factory settings</p> <p>Errors are thrown by default but can be "gracefully" skipped using the flag <code>GRACEFULLY_FAILURE</code>.
In all cases, error messages are loaded in final parameter <code>$logs</code> passed by reference.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>
</td>
</tr>
<tr>
<td>
int</td>
<td>$flag</td>
<td>One of the class constants flags</td>
</tr>
<tr>
<td>
array</td>
<td>$logs</td>
<td>Passed by reference</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
null|string</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>