PHP Класс Neos\Flow\Core\Bootstrap

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$staticObjectManager Neos\Flow\ObjectManagement\ObjectManagerInterface The same instance like $objectManager, but static, for use in the proxy classes.

Защищенные свойства (Protected)

Свойство Тип Описание
$activeRequestHandler Neos\Flow\Core\RequestHandlerInterface
$compiletimeCommands array
$context ApplicationContext
$earlyInstances array
$preselectedRequestHandlerClassName string
$requestHandlers array

Открытые методы

Метод Описание
__construct ( string $context ) Constructor
buildCompiletimeSequence ( ) : Sequence Builds a boot sequence starting all modules necessary for the compiletime state.
buildEssentialsSequence ( string $identifier ) : Sequence Builds a boot sequence with the minimum modules necessary for both, compiletime and runtime.
buildRuntimeSequence ( ) : Sequence Builds a boot sequence starting all modules necessary for the runtime state.
getActiveRequestHandler ( ) : Neos\Flow\Core\RequestHandlerInterface Returns the request handler (if any) which is currently handling the request.
getContext ( ) : ApplicationContext Returns the context this bootstrap was started in.
getEarlyInstance ( string $objectName ) : object Returns an instance which was registered earlier through setEarlyInstance()
getEarlyInstances ( ) : array Returns all registered early instances indexed by object name
getEnvironmentConfigurationSetting ( string $variableName ) : string Tries to find an environment setting with the following fallback chain:
getObjectManager ( ) : Neos\Flow\ObjectManagement\ObjectManagerInterface Returns the object manager instance
getSignalSlotDispatcher ( ) : Dispatcher Returns the signal slot dispatcher instance
initializePersistenceManager ( ) : Neos\Flow\Persistence\PersistenceManagerInterface
isCompiletimeCommand ( string $commandIdentifier ) : boolean Tells if the given command controller is registered for compiletime or not.
registerCompiletimeCommand ( string $commandIdentifier ) : void Registers a command specified by the given identifier to be called during compiletime (versus runtime). The related command controller must be totally aware of the limited functionality Flow provides at compiletime.
registerRequestHandler ( Neos\Flow\Core\RequestHandlerInterface $requestHandler ) : void Registers a request handler which can possibly handle a request.
run ( ) : void Bootstraps the minimal infrastructure, resolves a fitting request handler and then passes control over to that request handler.
setActiveRequestHandler ( Neos\Flow\Core\RequestHandlerInterface $requestHandler ) : void Explicitly sets the active request handler.
setEarlyInstance ( string $objectName, object $instance ) : void Registers the instance of the specified object for an early boot stage.
setPreselectedRequestHandlerClassName ( string $className ) Preselects a specific request handler. If such a request handler exists, it will be used if it can handle the request – regardless of the priority of this or other request handlers.
shutdown ( string $runlevel ) : void Initiates the shutdown procedure to safely close all connections, save modified data and commit other tasks necessary to cleanly exit Flow.

Защищенные методы

Метод Описание
defineConstants ( ) : void Defines various path constants used by Flow and if no root path or web root was specified by an environment variable, exits with a respective error message.
emitBootstrapShuttingDown ( string $runLevel ) : void Emits a signal that the bootstrap finished and is shutting down.
emitFinishedCompiletimeRun ( ) : void Emits a signal that the compile run was finished.
emitFinishedRuntimeRun ( ) : void Emits a signal that the runtime run was finished.
ensureRequiredEnvironment ( ) : void Checks PHP version and other parameters of the environment
resolveRequestHandler ( ) : Neos\Flow\Core\RequestHandlerInterface Iterates over the registered request handlers and determines which one fits best.

Описание методов

__construct() публичный Метод

Constructor
public __construct ( string $context )
$context string The application context, for example "Production" or "Development"

buildCompiletimeSequence() публичный Метод

This includes all of the "essentials" sequence.
public buildCompiletimeSequence ( ) : Sequence
Результат Neos\Flow\Core\Booting\Sequence

buildEssentialsSequence() публичный Метод

Builds a boot sequence with the minimum modules necessary for both, compiletime and runtime.
public buildEssentialsSequence ( string $identifier ) : Sequence
$identifier string
Результат Neos\Flow\Core\Booting\Sequence

buildRuntimeSequence() публичный Метод

This includes all of the "essentials" sequence.
public buildRuntimeSequence ( ) : Sequence
Результат Neos\Flow\Core\Booting\Sequence

defineConstants() защищенный Метод

Defines various path constants used by Flow and if no root path or web root was specified by an environment variable, exits with a respective error message.
protected defineConstants ( ) : void
Результат void

emitBootstrapShuttingDown() защищенный Метод

Emits a signal that the bootstrap finished and is shutting down.
protected emitBootstrapShuttingDown ( string $runLevel ) : void
$runLevel string
Результат void

emitFinishedCompiletimeRun() защищенный Метод

Emits a signal that the compile run was finished.
protected emitFinishedCompiletimeRun ( ) : void
Результат void

emitFinishedRuntimeRun() защищенный Метод

Emits a signal that the runtime run was finished.
protected emitFinishedRuntimeRun ( ) : void
Результат void

ensureRequiredEnvironment() защищенный Метод

Checks PHP version and other parameters of the environment
protected ensureRequiredEnvironment ( ) : void
Результат void

getActiveRequestHandler() публичный Метод

Returns the request handler (if any) which is currently handling the request.
public getActiveRequestHandler ( ) : Neos\Flow\Core\RequestHandlerInterface
Результат Neos\Flow\Core\RequestHandlerInterface

getContext() публичный Метод

Returns the context this bootstrap was started in.
public getContext ( ) : ApplicationContext
Результат ApplicationContext The context encapsulated in an object, for example "Development" or "Development/MyDeployment"

getEarlyInstance() публичный Метод

Returns an instance which was registered earlier through setEarlyInstance()
public getEarlyInstance ( string $objectName ) : object
$objectName string Object name of the registered instance
Результат object

getEarlyInstances() публичный Метод

Returns all registered early instances indexed by object name
public getEarlyInstances ( ) : array
Результат array

getEnvironmentConfigurationSetting() публичный статический Метод

- getenv with $variableName - getenv with REDIRECT_ . $variableName (this is for php cgi where environment variables from the http server get prefixed) - $_SERVER[$variableName] (this is an alternative to set FLOW_* environment variables if passing environment variables is not possible) - $_SERVER[REDIRECT_ . $variableName] (again for php cgi environments)
public static getEnvironmentConfigurationSetting ( string $variableName ) : string
$variableName string
Результат string or NULL if this variable was not set at all.

getObjectManager() публичный Метод

Returns the object manager instance
public getObjectManager ( ) : Neos\Flow\ObjectManagement\ObjectManagerInterface
Результат Neos\Flow\ObjectManagement\ObjectManagerInterface

getSignalSlotDispatcher() публичный Метод

Returns the signal slot dispatcher instance
public getSignalSlotDispatcher ( ) : Dispatcher
Результат Neos\Flow\SignalSlot\Dispatcher

initializePersistenceManager() публичный Метод

public initializePersistenceManager ( ) : Neos\Flow\Persistence\PersistenceManagerInterface
Результат Neos\Flow\Persistence\PersistenceManagerInterface

isCompiletimeCommand() публичный Метод

Tells if the given command controller is registered for compiletime or not.
public isCompiletimeCommand ( string $commandIdentifier ) : boolean
$commandIdentifier string Package key, controller name and command name separated by colon, e.g. "neos.flow:cache:flush"
Результат boolean

registerCompiletimeCommand() публичный Метод

Registers a command specified by the given identifier to be called during compiletime (versus runtime). The related command controller must be totally aware of the limited functionality Flow provides at compiletime.
public registerCompiletimeCommand ( string $commandIdentifier ) : void
$commandIdentifier string Package key, controller name and command name separated by colon, e.g. "neos.flow:core:shell", wildcard for command name possible: "neos.flow:core:*"
Результат void

registerRequestHandler() публичный Метод

All registered request handlers will be queried if they can handle a request when the bootstrap's run() method is called.
public registerRequestHandler ( Neos\Flow\Core\RequestHandlerInterface $requestHandler ) : void
$requestHandler Neos\Flow\Core\RequestHandlerInterface
Результат void

resolveRequestHandler() защищенный Метод

Iterates over the registered request handlers and determines which one fits best.
protected resolveRequestHandler ( ) : Neos\Flow\Core\RequestHandlerInterface
Результат Neos\Flow\Core\RequestHandlerInterface A request handler

run() публичный Метод

Bootstraps the minimal infrastructure, resolves a fitting request handler and then passes control over to that request handler.
public run ( ) : void
Результат void

setActiveRequestHandler() публичный Метод

This method makes only sense to use during functional tests. During a functional test run the active request handler chosen by the bootstrap will be a command line request handler specialized on running functional tests. A functional test case can then set the active request handler to one which simulates, for example, an HTTP request.
public setActiveRequestHandler ( Neos\Flow\Core\RequestHandlerInterface $requestHandler ) : void
$requestHandler Neos\Flow\Core\RequestHandlerInterface
Результат void

setEarlyInstance() публичный Метод

On finalizing the Object Manager initialization, all those instances will be transferred to the Object Manager's registry.
public setEarlyInstance ( string $objectName, object $instance ) : void
$objectName string Object name, as later used by the Object Manager
$instance object The instance to register
Результат void

setPreselectedRequestHandlerClassName() публичный Метод

Preselects a specific request handler. If such a request handler exists, it will be used if it can handle the request – regardless of the priority of this or other request handlers.
public setPreselectedRequestHandlerClassName ( string $className )
$className string

shutdown() публичный Метод

This method should be called by a request handler after a successful run. Control is returned to the request handler which can exit the application as it sees fit.
public shutdown ( string $runlevel ) : void
$runlevel string one of the RUNLEVEL_* constants
Результат void

Описание свойств

$activeRequestHandler защищенное свойство

protected RequestHandlerInterface,Neos\Flow\Core $activeRequestHandler
Результат Neos\Flow\Core\RequestHandlerInterface

$compiletimeCommands защищенное свойство

protected array $compiletimeCommands
Результат array

$context защищенное свойство

protected ApplicationContext,Neos\Flow\Core $context
Результат ApplicationContext

$earlyInstances защищенное свойство

protected array $earlyInstances
Результат array

$preselectedRequestHandlerClassName защищенное свойство

protected string $preselectedRequestHandlerClassName
Результат string

$requestHandlers защищенное свойство

protected array $requestHandlers
Результат array

$staticObjectManager публичное статическое свойство

The same instance like $objectManager, but static, for use in the proxy classes.
public static ObjectManagerInterface,Neos\Flow\ObjectManagement $staticObjectManager
Результат Neos\Flow\ObjectManagement\ObjectManagerInterface