Class LoaderPluginManager

Summary

Fully Qualified Name: Zend\I18n\Translator\LoaderPluginManager
Extends: AbstractPluginManager

Description

Plugin manager implementation for translation loaders.

Enforces that loaders retrieved are either instances of Loader\FileLoaderInterface or Loader\RemoteLoaderInterface. Additionally, it registers a number of default loaders.

If you are wanting to use the ability to load translation files from the include_path, you will need to create a factory to override the defaults defined in this class. A simple factory might look like:

function ($translators) {

$adapter = new Gettext();
$adapter->setUseIncludePath(true);
return $adapter;

}

You may need to override the Translator service factory to make this happen more easily. That can be done by extending it:

use Zend\I18n\Translator\TranslatorServiceFactory; // or Zend\Mvc\I18n\TranslatorServiceFactory use Zend\ServiceManager\ServiceLocatorInterface;

class MyTranslatorServiceFactory extends TranslatorServiceFactory {

public function createService(ServiceLocatorInterface $services)
{
    $translator = parent::createService($services);
    $translator->getLoaderPluginManager()->setFactory(...);
    return $translator;
}

}

You would then specify your custom factory in your service configuration.

Methods

Name Description Defined By
__construct() Constructor. AbstractPluginManager
addAbstractFactory() Add an abstract factory for resolving services. ServiceManager
addDelegator() Add a delegator for a given service. ServiceManager
addInitializer() Add an initializer. ServiceManager
build() {@inheritDoc} ServiceManager
configure() Override configure() to validate service instances. AbstractPluginManager
get() {@inheritDoc} AbstractPluginManager
getAllowOverride() Retrieve the flag indicating immutability status. ServiceManager
getServiceLocator() Implemented for backwards compatibility with previous plugin managers only. ServiceManager
has() {@inheritDoc} ServiceManager
mapLazyService() Create a lazy service mapping to a class. ServiceManager
setAlias() Add an alias. ServiceManager
setAllowOverride() Indicate whether or not the instance is immutable. ServiceManager
setFactory() Specify a factory for a given service name. ServiceManager
setInvokableClass() Add an invokable class mapping. ServiceManager
setService() Map a service. ServiceManager
setServiceLocator() Implemented for backwards compatibility only. AbstractPluginManager
setShared() Add a service sharing rule. ServiceManager
validate() Validate the plugin. LoaderPluginManager
validatePlugin() Validate the plugin is of the expected type (v2). LoaderPluginManager

Method Details

__construct()

Constructor.

Sets the provided $parentLocator as the creation context for all factories; for $config, {@see \Zend\ServiceManager\ServiceManager::configure()} for details on its accepted structure.

Parameter Name Type Description
$configInstanceOrParentLocator null|\ConfigInterface|\ContainerInterface|\PsrContainerInterface
$config array

Returns:

addAbstractFactory()

Add an abstract factory for resolving services.

Parameter Name Type Description
$factory string|\Factory\AbstractFactoryInterface Service

Returns:

addDelegator()

Add a delegator for a given service.

Parameter Name Type Description
$name string Service
$factory string|callable|\Factory\DelegatorFactoryInterface Delegator factory

Returns:

addInitializer()

Add an initializer.

Parameter Name Type Description
$initializer string|callable|\Initializer\InitializerInterface

Returns:

build()

{@inheritDoc}

Parameter Name Type Description
$name
$options

Returns:

configure()

Override configure() to validate service instances.

If an instance passed in the services configuration is invalid for the plugin manager, this method will raise an InvalidServiceException.

{@inheritDoc}

Parameter Name Type Description
$config

Returns:

get()

{@inheritDoc}

Parameter Name Type Description
$name string Service
$options null|array Options

Returns: mixed

getAllowOverride()

Retrieve the flag indicating immutability status.

Returns: bool

getServiceLocator()

Implemented for backwards compatibility with previous plugin managers only.

Returns the creation context.

Returns: \ContainerInterface

has()

{@inheritDoc}

Parameter Name Type Description
$name

Returns:

mapLazyService()

Create a lazy service mapping to a class.

Parameter Name Type Description
$name string Service
$class null|string Class

Returns:

setAlias()

Add an alias.

Parameter Name Type Description
$alias string
$target string

Returns:

setAllowOverride()

Indicate whether or not the instance is immutable.

Parameter Name Type Description
$flag bool

Returns:

setFactory()

Specify a factory for a given service name.

Parameter Name Type Description
$name string Service
$factory string|callable|\Factory\FactoryInterface Factory

Returns:

setInvokableClass()

Add an invokable class mapping.

Parameter Name Type Description
$name string Service
$class null|string Class

Returns:

setService()

Map a service.

Parameter Name Type Description
$name string Service
$service array|object

Returns:

setServiceLocator()

Implemented for backwards compatibility only.

Returns the creation context.

Parameter Name Type Description
$container \ContainerInterface

Returns: void

setShared()

Add a service sharing rule.

Parameter Name Type Description
$name string Service
$flag bool Whether

Returns:

validate()

Validate the plugin.

Checks that the filter loaded is an instance of Loader\FileLoaderInterface or Loader\RemoteLoaderInterface.

Parameter Name Type Description
$plugin mixed

Returns: void

validatePlugin()

Validate the plugin is of the expected type (v2).

Proxies to validate().

Parameter Name Type Description
$plugin mixed

Returns:

Top