Class HelperPluginManager

Summary

Fully Qualified Name: Zend\View\HelperPluginManager
Extends: AbstractPluginManager

Description

Plugin manager implementation for view helpers

Enforces that helpers retrieved are instances of Helper\HelperInterface. Additionally, it registers a number of default helpers.

Methods

Name Description Defined By
__construct() Constructor HelperPluginManager
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
getRenderer() Retrieve renderer instance HelperPluginManager
getServiceLocator() Implemented for backwards compatibility with previous plugin managers only. ServiceManager
has() {@inheritDoc} ServiceManager
injectEventManager() Inject a helper instance with the registered event manager HelperPluginManager
injectRenderer() Inject a helper instance with the registered renderer HelperPluginManager
injectTranslator() Inject a helper instance with the registered translator HelperPluginManager
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
setRenderer() Set renderer HelperPluginManager
setService() Map a service. ServiceManager
setServiceLocator() Implemented for backwards compatibility only. AbstractPluginManager
setShared() Add a service sharing rule. ServiceManager
validate() Validate the plugin is of the expected type (v3). HelperPluginManager
validatePlugin() Validate the plugin is of the expected type (v2). HelperPluginManager

Method Details

__construct()

Constructor

Merges provided configuration with default configuration.

Adds initializers to inject the attached renderer and translator, if any, to the currently requested helper.

Parameter Name Type Description
$configOrContainerInstance null|\ConfigInterface|\ContainerInterface
$v3config array If

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

getRenderer()

Retrieve renderer instance

Returns: null|\Renderer\RendererInterface

getServiceLocator()

Implemented for backwards compatibility with previous plugin managers only.

Returns the creation context.

Returns: \ContainerInterface

has()

{@inheritDoc}

Parameter Name Type Description
$name

Returns:

injectEventManager()

Inject a helper instance with the registered event manager

Parameter Name Type Description
$first \ContainerInterface|\Helper\HelperInterface helper
$second \ContainerInterface|\Helper\HelperInterface ContainerInterface

Returns:

injectRenderer()

Inject a helper instance with the registered renderer

Parameter Name Type Description
$first \ContainerInterface|\Helper\HelperInterface helper
$second \ContainerInterface|\Helper\HelperInterface ContainerInterface

Returns:

injectTranslator()

Inject a helper instance with the registered translator

Parameter Name Type Description
$first \ContainerInterface|\Helper\HelperInterface helper
$second \ContainerInterface|\Helper\HelperInterface ContainerInterface

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:

setRenderer()

Set renderer

Parameter Name Type Description
$renderer \Renderer\RendererInterface

Returns: \HelperPluginManager

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 is of the expected type (v3).

Validates against callables and HelperInterface implementations.

Parameter Name Type Description
$instance mixed

Returns:

validatePlugin()

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

Proxies to validate().

Parameter Name Type Description
$instance mixed

Returns:

Top