Alpha Framework 3.1.0 API Documentation

ServiceFactory

A factory for creating service instances that match the provider name and interface provided

Tags
since
3.0
author

John Collins dev@alphaframework.org

license

http://www.opensource.org/licenses/bsd-license.php The BSD License

copyright

Copyright (c) 2018, John Collins (founder of Alpha Framework). All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Table of Contents

$logger  : Logger
Trace logger.
$singletons  : array<string|int, mixed>
A static array of service singletons in case any service needs to be accessed as a single instance.
getInstance()  : stdClass
A static method that attempts to return a service provider instance based on the name of the provider class supplied. If the instance does not implement the desired interface, an exception is thrown.

Properties

$singletons

A static array of service singletons in case any service needs to be accessed as a single instance.

private static array<string|int, mixed> $singletons = array()
Tags
since
3.0

Methods

getInstance()

A static method that attempts to return a service provider instance based on the name of the provider class supplied. If the instance does not implement the desired interface, an exception is thrown.

public static getInstance(string $serviceName, string $serviceInterface[, bool $isSingleton = false ]) : stdClass
Parameters
$serviceName : string

The class name of the service class (fully qualified).

$serviceInterface : string

The interface name of the service class returned (fully qualified).

$isSingleton : bool = false

Set to true if the service instance requested is a singleton, default is false (you get a new instance each time).

Tags
throws
IllegalArguementException
since
3.0
Return values
stdClass —

Search results