Class InputFilterPluginManager

Summary

Fully Qualified Name: Laminas\InputFilter\InputFilterPluginManager
Extends: AbstractPluginManager

Description

Plugin manager implementation for input filters.

Methods

Name Description Defined By
__construct() InputFilterPluginManager
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
populateFactory() Inject this and populate the factory with filter chain and validator chain InputFilterPluginManager
populateFactoryPluginManagers() Populate the filter and validator managers for the default filter/validator chains. InputFilterPluginManager
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() {@inheritDoc} (v3) InputFilterPluginManager
validatePlugin() Validate the plugin (v2) InputFilterPluginManager

Method Details

__construct()

Parameter Name Type Description
$configOrContainer null|\Laminas\ServiceManager\ConfigInterface|\ContainerInterface For
$v3config array Optional

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:

populateFactory()

Inject this and populate the factory with filter chain and validator chain

Parameter Name Type Description
$containerOrInputFilter \ContainerInterface|\InputFilter When
$inputFilter \InputFilter This

Returns:

populateFactoryPluginManagers()

Populate the filter and validator managers for the default filter/validator chains.

Parameter Name Type Description
$factory \Factory

Returns: void

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()

{@inheritDoc} (v3)

Parameter Name Type Description
$plugin

Returns:

validatePlugin()

Validate the plugin (v2)

Checks that the filter loaded is either a valid callback or an instance of FilterInterface.

Parameter Name Type Description
$plugin mixed

Returns: void

Top