Zend Framework  3.0
Public Member Functions | Protected Attributes | List of all members
ControllerManager Class Reference

Manager for loading controllers. More...

Public Member Functions

 __construct ($configOrContainerInstance, array $v3config=[])
 Constructor.
 
 validate ($plugin)
 Validate a plugin (v3)
 
 validatePlugin ($plugin)
 Validate a plugin (v2)
 
 injectEventManager ($first, $second)
 Initializer: inject EventManager instance.
 
 injectPluginManager ($first, $second)
 Initializer: inject plugin manager.
 
- Public Member Functions inherited from AbstractPluginManager
 __construct ($configInstanceOrParentLocator=null, array $config=[])
 Constructor.
 
 configure (array $config)
 Override configure() to validate service instances.
 
 get ($name, array $options=null)
 
 
 validate ($instance)
 Validate an instance.
Parameters
object$instance
Returns
void
Exceptions
InvalidServiceExceptionIf created instance does not respect the constraint on type imposed by the plugin manager
ContainerExceptionif any other error occurs

 
 setServiceLocator (ContainerInterface $container)
 Implemented for backwards compatibility only.
 
- Public Member Functions inherited from ServiceManager
 __construct (array $config=[])
 Constructor.
 
 getServiceLocator ()
 Implemented for backwards compatibility with previous plugin managers only.
 
 get ($name)
 
 
 build ($name, array $options=null)
 Build a service by its name, using optional options (such services are NEVER cached).
Parameters
string$name
null | array$options
Returns
mixed
Exceptions
Exception\ServiceNotFoundExceptionIf no factory/abstract factory could be found to create the instance.
Exception\ServiceNotCreatedExceptionIf factory/delegator fails to create the instance.
ContainerExceptionif any other error occurs

 
 has ($name)
 
 
 setAllowOverride ($flag)
 Indicate whether or not the instance is immutable.
 
 getAllowOverride ()
 Retrieve the flag indicating immutability status.
 
 configure (array $config)
 Configure the service manager.
 
 setAlias ($alias, $target)
 Add an alias.
 
 setInvokableClass ($name, $class=null)
 Add an invokable class mapping.
 
 setFactory ($name, $factory)
 Specify a factory for a given service name.
 
 mapLazyService ($name, $class=null)
 Create a lazy service mapping to a class.
 
 addAbstractFactory ($factory)
 Add an abstract factory for resolving services.
 
 addDelegator ($name, $factory)
 Add a delegator for a given service.
 
 addInitializer ($initializer)
 Add an initializer.
 
 setService ($name, $service)
 Map a service.
 
 setShared ($name, $flag)
 Add a service sharing rule.
 

Protected Attributes

 $autoAddInvokableClass = false
 
 $instanceOf = DispatchableInterface::class
 
- Protected Attributes inherited from AbstractPluginManager
 $autoAddInvokableClass = true
 
 $instanceOf = null
 
- Protected Attributes inherited from ServiceManager
 $abstractFactories = []
 
 $aliases = []
 
 $allowOverride = false
 Whether or not changes may be made to this instance.
 
 $creationContext
 
 $delegators = []
 
 $factories = []
 
 $initializers = []
 
 $lazyServices = []
 
 $services = []
 
 $shared = []
 
 $sharedByDefault = true
 
 $configured = false
 

Detailed Description

Manager for loading controllers.

Does not define any controllers by default, but does add a validator.

Constructor & Destructor Documentation

__construct (   $configOrContainerInstance,
array  $v3config = [] 
)

Constructor.

Injects an initializer for injecting controllers with an event manager and plugin manager.

Parameters
ConfigInterface | ContainerInterface$container
array$v3config

Member Function Documentation

injectEventManager (   $first,
  $second 
)

Initializer: inject EventManager instance.

If we have an event manager composed already, make sure it gets injected with the shared event manager.

The AbstractController lazy-instantiates an EM instance, which is why the shared EM injection needs to happen; the conditional will always pass.

Parameters
ContainerInterface | DispatchableInterface$firstContainer when using zend-servicemanager v3; controller under v2.
DispatchableInterface | ContainerInterface$secondController when using zend-servicemanager v3; container under v2.
injectPluginManager (   $first,
  $second 
)

Initializer: inject plugin manager.

Parameters
ContainerInterface | DispatchableInterface$firstContainer when using zend-servicemanager v3; controller under v2.
DispatchableInterface | ContainerInterface$secondController when using zend-servicemanager v3; container under v2.
validate (   $plugin)

Validate a plugin (v3)

Validate an instance.

Parameters
object$instance
Returns
void
Exceptions
InvalidServiceExceptionIf created instance does not respect the constraint on type imposed by the plugin manager
ContainerExceptionif any other error occurs

Implements PluginManagerInterface.

validatePlugin (   $plugin)

Validate a plugin (v2)

Exceptions
Exception\InvalidControllerException

Member Data Documentation

$autoAddInvokableClass = false
protected
$instanceOf = DispatchableInterface::class
protected