eZPublishCommunityProject(LegacyStack)  2013.9
ezpKernelWeb Class Reference

File containing the ezpKernelWeb class. More...

+ Inheritance diagram for ezpKernelWeb:
+ Collaboration diagram for ezpKernelWeb:

Public Member Functions

 __construct (array $settings=array())
 Constructs an ezpKernel instance. More...
 
 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)
 Run a callback function in legacy environment. More...
 
 setUseExceptions ($useExceptions)
 Sets whether to use exceptions in legacy kernel. More...
 
 setUsePagelayout ($usePagelayout)
 Allows user to avoid executing the pagelayout template when running the kernel. More...
 

Protected Member Functions

 dispatchLoop ()
 Runs the dispatch loop. More...
 
 getPolicyCheckViewMap (array $policyCheckOmitList)
 Returns the map for policy check view. More...
 
 redirect ()
 Performs a redirection. More...
 
 requestInit ()
 
 sessionInit ()
 Initializes the session. More...
 
 shutdown ($reInitialize=true)
 Runs the shutdown process. More...
 

Protected Attributes

 $isInitialized = false
 
 $settings = array()
 

Private Attributes

 $access
 
 $actualRequestedURI
 
 $check
 
 $completeRequestedURI
 
 $httpCharset
 
 $languageCode
 
 $mobileDeviceDetect
 
 $module
 
 $oldURI
 
 $policyCheckViewMap
 
 $site
 
 $siteBasics
 
 $uri
 
 $warningList = array()
 

Detailed Description

File containing the ezpKernelWeb class.

Version
2013.9 Provides a kernel handler in web context

Allows kernel to be executed as Controller via run()

Constructor & Destructor Documentation

ezpKernelWeb::__construct ( array  $settings = array())

Constructs an ezpKernel instance.

Member Function Documentation

ezpKernelWeb::dispatchLoop ( )
protected

Runs the dispatch loop.

Referenced by run().

ezpKernelWeb::getPolicyCheckViewMap ( array  $policyCheckOmitList)
protected

Returns the map for policy check view.

Parameters
array$policyCheckOmitList
Returns
array

Referenced by dispatchLoop().

ezpKernelWeb::getServiceContainer ( )

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

Returns
|null

Implements ezpKernelHandler.

Referenced by __construct().

ezpKernelWeb::hasServiceContainer ( )

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

Returns
bool

Implements ezpKernelHandler.

Referenced by __construct().

ezpKernelWeb::redirect ( )
protected

Performs a redirection.

Referenced by run().

ezpKernelWeb::reInitialize ( )

Reinitializes the kernel environment.

Implements ezpKernelHandler.

ezpKernelWeb::requestInit ( )
protected

Check for activating Debug by user ID (Final checking. The first was in eZDebug::updateSettings()) eZUser::instance() So needs to be executed after eZSession::start()|lazyStart()

Referenced by run(), and runCallback().

ezpKernelWeb::run ( )

Execution point for controller actions.

Ouput an is_logged_in cookie when users are logged in for use by http cache solutions.

Deprecated:
As of 4.5, since 4.4 added lazy session support (init on use)

Implements ezpKernelHandler.

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

Run a callback function in legacy environment.

Implements ezpKernelHandler.

ezpKernelWeb::sessionInit ( )
protected

Initializes the session.

If running, through Symfony the session parameters from Symfony override the session parameter from eZ Publish.

Referenced by requestInit().

ezpKernelWeb::setUseExceptions (   $useExceptions)

Sets whether to use exceptions in legacy kernel.

Parameters
bool$useExceptions

Implements ezpKernelHandler.

Referenced by __construct().

ezpKernelWeb::setUsePagelayout (   $usePagelayout)

Allows user to avoid executing the pagelayout template when running the kernel.

Parameters
bool$usePagelayout

Implements ezpWebBasedKernelHandler.

ezpKernelWeb::shutdown (   $reInitialize = true)
protected

Runs the shutdown process.

Referenced by run(), and runCallback().

Member Data Documentation

ezpKernelWeb::$access
private
ezpKernelWeb::$actualRequestedURI
private
ezpKernelWeb::$check
private
ezpKernelWeb::$completeRequestedURI
private

Referenced by run().

ezpKernelWeb::$httpCharset
private
ezpKernelWeb::$isInitialized = false
protected
ezpKernelWeb::$languageCode
private
ezpKernelWeb::$mobileDeviceDetect
private
ezpKernelWeb::$module
private
ezpKernelWeb::$oldURI
private

Referenced by run().

ezpKernelWeb::$policyCheckViewMap
private
ezpKernelWeb::$settings = array()
protected

Referenced by __construct().

ezpKernelWeb::$site
private
ezpKernelWeb::$siteBasics
private
ezpKernelWeb::$uri
private

Referenced by dispatchLoop(), redirect(), and requestInit().

ezpKernelWeb::$warningList = array()
private

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