FF/docs/html/classes/FF_Factories_SF.xhtml
2019-06-27 10:29:52 +02:00

233 lines
11 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<title>phpDox - FF\Factories\SF</title>
<link rel="stylesheet" type="text/css" href="../css/style.css" media="screen"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
</head>
<body>
<nav class="topnav">
<ul>
<li>
<div class="logo"><span>/**</span>phpDox</div>
</li>
<li class="separator">
<a href="../index.xhtml">Overview</a>
</li>
<li class="separator">
<a href="../namespaces.xhtml">Namespaces</a>
</li>
<li>
<a href="../interfaces.xhtml">Interfaces</a>
</li>
<li>
<a href="../classes.xhtml">Classes</a>
</li>
<li>
<a href="../traits.xhtml">Traits</a>
</li>
<li class="separator">
<a href="../source/index.xhtml">Source</a>
</li>
</ul>
</nav>
<div id="mainstage">
<div class="box">
<ul class="breadcrumb">
<li>
<a href="../index.xhtml">Overview</a>
</li>
<li class="separator">
<a href="../classes.xhtml">Classes</a>
</li>
<li class="separator">
<a href="../classes.xhtml#FF_Factories">FF\Factories</a>
</li>
<li class="separator">SF</li>
</ul>
</div>
<nav class="box">
<ul>
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#synopsis">Synopsis</a>
</li>
<li>
<a href="#hierarchy">Hierarchy</a>
</li>
<li>
<a href="#coverage">Coverage</a>
</li>
<li>
<a href="#violations">Violations</a>
</li>
<li>
<a href="#members">Members</a>
</li>
<li>
<a href="#methods">Methods</a>
</li>
<li>
<a href="#history">History</a>
</li>
<li>
<a href="../source/Factories/SF.php.xhtml#line18">Source</a>
</li>
</ul>
</nav>
<section>
<h1 id="introduction"><small>FF\Factories\</small>SF</h1>
<h4>Class SF</h4>
<p/>
<ul/>
<h2 id="synopsis">Synopsis</h2>
<div class="synopsis">class SF
extends <a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory.xhtml">ServicesFactory</a>
{<br/><ul class="none"><li>// Inherited members from <span title="FF\Factories\ServicesFactory">ServicesFactory</span></li><li>protected static <span title="FF\Factories\ServicesFactory">ServicesFactory</span> <a href="#members">$instance</a>;
</li><li>protected  <a href="#members">$servicesOptions</a>;
</li></ul><ul class="none"><li>// methods</li><li>public static <span title="ServicesFactory">ServicesFactory</span> <a title="FF\Factories\SF" href="../classes/FF_Factories_SF/i.xhtml">i</a>()
</li></ul><ul class="none"><li>// Inherited methods from <span title="FF\Factories\ServicesFactory">ServicesFactory</span></li><li>public void <a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory/__construct.xhtml">__construct</a>()
</li><li>public static void <a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory/setInstance.xhtml">setInstance</a>()
</li><li>public static ServicesFactory <a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory/getInstance.xhtml">getInstance</a>()
</li><li>public static void <a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory/clearInstance.xhtml">clearInstance</a>()
</li><li>public array <a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory/get.xhtml">get</a>()
</li><li>public AbstractService <a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory/create.xhtml">create</a>()
</li><li>public BaseNamespaceClassLocator <a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory/getClassLocator.xhtml">getClassLocator</a>()
</li><li>public array <a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory/getServiceOptions.xhtml">getServiceOptions</a>()
</li></ul>
}<br/></div>
<h2 id="hierarchy">Hierarchy</h2>
<div class="styled">
<h4>Extends</h4>
<ul>
<li>
<a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory.xhtml">FF\Factories\ServicesFactory</a>
</li>
</ul>
</div>
<h2 id="coverage">Coverage</h2>
<table class="styled">
<tr>
<td>Methods</td>
<td class="percent">0%</td>
<td class="nummeric">0 / 1</td>
</tr>
<tr>
<td>Lines</td>
<td class="percent">0%</td>
<td class="nummeric"> / </td>
</tr>
</table>
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">25 - 28</td>
<td>
<a href="http://phpmd.org/rules/naming.html#shortmethodname" target="_blank" title="Naming Rules">ShortMethodName</a>
</td>
<td>Avoid using short method names like SF::i(). The configured minimum method name length is 3.</td>
</tr>
</table>
</div>
<h2 id="members">Members</h2>
<div class="styled members">
<h4>protected</h4>
<ul class="members">
<li id="instance"><strong>$instance</strong>
<a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory.xhtml">FF\Factories\ServicesFactory</a></li>
<li id="servicesOptions"><strong>$servicesOptions</strong>
array</li>
</ul>
</div>
<h2 id="methods">Methods</h2>
<div class="styled">
<h4>public</h4>
<ul>
<li id="i"><a title="FF\Factories\SF" href="../classes/FF_Factories_SF/i.xhtml">i()</a>
— Retrieves the ServicesFactory's singleton instance</li>
</ul>
<h3>Inherited from <a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory.xhtml">FF\Factories\ServicesFactory</a></h3>
<h4>public</h4>
<ul>
<li id="clearInstance"><a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory/clearInstance.xhtml">clearInstance()</a>
— Removes the singleton instance of this class</li>
<li id="create"><a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory/create.xhtml">create()</a>
— {@inheritdoc}</li>
<li id="get"><a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory/get.xhtml">get()</a>
— Retrieves one ro more fully initialized services</li>
<li id="getClassLocator"><a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory/getClassLocator.xhtml">getClassLocator()</a>
— {@inheritDoc}</li>
<li id="getInstance"><a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory/getInstance.xhtml">getInstance()</a>
— Retrieves the singleton instance of this class</li>
<li id="getServiceOptions"><a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory/getServiceOptions.xhtml">getServiceOptions()</a>
— Retrieves the options for a specific service</li>
<li id="setInstance"><a title="FF\Factories\ServicesFactory" href="../classes/FF_Factories_ServicesFactory/setInstance.xhtml">setInstance()</a>
— Sets the singleton instance of this class</li>
</ul>
</div>
<h2 id="history">History</h2>
<ul class="styled history">
<li>
<h3>2019-06-26T12:47:05+02:00 (commit #<span title="6d7d5f111e89497807e5b414a08fd7b5627d78a4">6d7d5f1</span>)</h3>
<div>
<p>
Author: Marco Stoll (marco.stoll@rocketmail.com) /
Commiter: Marco Stoll (marco.stoll@rocketmail.com)
</p>
<pre class="wrapped">[FEATURE] add phpcs using PSR2</pre>
</div>
</li>
<li>
<h3>2019-06-21T10:36:57+02:00 (commit #<span title="fc1d028b6a625a4797739139e2fbd70bc19828c5">fc1d028</span>)</h3>
<div>
<p>
Author: Marco Stoll (marco.stoll@rocketmail.com) /
Commiter: Marco Stoll (marco.stoll@rocketmail.com)
</p>
<pre class="wrapped">[REFACTOR] reorganize namespaces for factories</pre>
</div>
</li>
<li>
<h3>2019-06-21T08:46:03+02:00 (commit #<span title="b579d5b9c26169695890ba5a47c520561c7f7468">b579d5b</span>)</h3>
<div>
<p>
Author: Marco Stoll (marco.stoll@rocketmail.com) /
Commiter: Marco Stoll (marco.stoll@rocketmail.com)
</p>
<pre class="wrapped">[CHANGE] move factories to sub namespace</pre>
</div>
</li>
<li>
<h3>2019-06-20T12:13:45+02:00 (commit #<span title="78e793f8e3127e2c876dc1867b084c3a4c26442c">78e793f</span>)</h3>
<div>
<p>
Author: Marco Stoll (marco.stoll@rocketmail.com) /
Commiter: Marco Stoll (marco.stoll@rocketmail.com)
</p>
<pre class="wrapped">[FEATURE] services and services factory</pre>
</div>
</li>
</ul>
</section>
</div>
<footer>
<span>Generated using phpDox 0.12.0-dev - Copyright (C) 2010 - 2019 by Arne Blankerts and Contributors</span>
</footer>
</body>
</html>