eZPublishCommunityProject(LegacyStack)  2013.6
ezpKernelHandler Interface Reference

File containing the ezpKernelHandler interface. More...

+ Inheritance diagram for ezpKernelHandler:

Public Member Functions

 getServiceContainer ()
 Returns the Symfony service container if it has been injected, otherwise returns null. More...
 
 hasServiceContainer ()
 Checks whether the kernel handler has the Symfony service container container or not. More...
 
 reInitialize ()
 Reinitializes the kernel environment. More...
 
 run ()
 Execution point for controller actions. More...
 
 runCallback (\Closure $callback, $postReinitialize=true)
 Runs a callback function in the kernel environment. More...
 
 setUseExceptions ($useExceptions)
 Sets whether to use exceptions inside the kernel. More...
 

Detailed Description

File containing the ezpKernelHandler interface.

Version
2013.6 Interface for kernel handlers

Member Function Documentation

ezpKernelHandler::getServiceContainer ( )

Returns the Symfony service container if it has been injected, otherwise returns null.

Returns
|null

Implemented in ezpKernelWeb, ezpKernelTreeMenu, and ezpKernel.

ezpKernelHandler::hasServiceContainer ( )

Checks whether the kernel handler has the Symfony service container container or not.

Returns
bool

Implemented in ezpKernelWeb, ezpKernelTreeMenu, and ezpKernel.

ezpKernelHandler::reInitialize ( )

Reinitializes the kernel environment.

Returns
void

Implemented in ezpKernelWeb, ezpKernelTreeMenu, and ezpKernel.

ezpKernelHandler::run ( )

Execution point for controller actions.

Returns false if not supported

Returns
ezpKernelResult

Implemented in ezpKernelWeb, ezpKernelTreeMenu, and ezpKernel.

ezpKernelHandler::runCallback ( \Closure  $callback,
  $postReinitialize = true 
)

Runs a callback function in the kernel environment.

This is useful to run eZ Publish 4.x code from a non-related context (like eZ Publish 5)

Parameters
\Closure$callback
bool$postReinitializeDefault is true. If set to false, the kernel environment will not be reinitialized. This can be useful to optimize several calls to the kernel within the same context.
Returns
mixed The result of the callback

Implemented in ezpKernelWeb, ezpKernelTreeMenu, and ezpKernel.

ezpKernelHandler::setUseExceptions (   $useExceptions)

Sets whether to use exceptions inside the kernel.

Parameters
bool$useExceptions

Implemented in ezpKernelWeb, ezpKernelTreeMenu, and ezpKernel.


The documentation for this interface was generated from the following file: