Cli
extends Application
in package
AbstractYes
Tags
Table of Contents
Properties
- $config : array<string|int, mixed>
- The configuration loaded from the 'app' configuration group
- $context : IContext
- $dispatcher : IDispatcher
- $driver_manager : DriverManager
- $errors : array<string|int, mixed>
- $event_dispatcher : IEventDispatcher
- $instance : mixed
- $kind : string
- $name : string
- $notices : array<string|int, mixed>
- $request : IRequest
- $response : IResponse
- $router : IRouter
- $schema_manager : SchemaManager
- $session : ISession
- $warnings : array<string|int, mixed>
- $hashCode : int
- $hashCounter : int
- $profile_run_uri : Uri
- $temporary_directory : string
Methods
- __call() : mixed
- __callStatic() : mixed
- __destruct() : mixed
- __get() : mixed
- addError() : void
- addErrors() : void
- addNotice() : void
- Add a notice to this application
- addNotices() : void
- Add a set of notices to this application
- addRoute() : mixed
- addWarning() : void
- Adds a warning to this application
- addWarnings() : void
- Adds a set of warnings to this application
- clearErrors() : void
- Clears all existing errors within this application
- clearNotices() : void
- Clears all existing notices within this application
- clearWarnings() : void
- Clears all existing warnings within this application
- execute() : IResponse
- {@inheritdoc}
- extends() : bool
- getConfig() : array<string|int, mixed>
- getContext() : IContext
- getDispatcher() : Dispatcher
- getDriverManager() : DriverManager
- getErrors() : array<string|int, mixed>
- Gets all existing errors within this application
- getEventDispatcher() : IEventDispatcher
- getInstance() : IApplication
- getKind() : string
- Gets the kind of this application. Return value will be one of 'cli', 'api', 'site'
- getName() : string
- Gets the name of the application.
- getNotices() : array<string|int, mixed>
- Get all existing notices within this application
- getProfileNamespace() : string
- getProfileRunLink() : string
- getProfileRunUri() : Uri|null
- getReflection() : ReflectionClass
- getRequest() : IRequest
- getResponse() : IResponse
- getRouter() : IRouter
- getSchemaManager() : SchemaManager
- getSession() : ISession
- getTemporaryDirectory() : string
- getVersion() : string
- getWarnings() : array<string|int, mixed>
- Gets all warnings within this application
- isJournaling() : bool
- isProfiling() : bool
- redirect() : void
- If the current application being run is of the kind 'api' or 'site' then an HTTP 'Location' header for a particular URI will be sent and execution will end. If however the application being run is of the kind 'cli' then execution will be redirected to another controller and action within the cli application
- respond() : IResponse
- {@inheritdoc}
- setErrors() : void
- setNotices() : void
- setProfileRunUri() : mixed
- setWarnings() : void
- __construct() : mixed
- init() : mixed
- {@inheritdoc}
- logError() : void
- Logs a message as an error
- onAfterExec() : void
- onBeforeExec() : void
- setDispatcher() : mixed
- setEventDispatcher() : mixed
- setKind() : mixed
- setName() : mixed
- setRequest() : mixed
- setResponse() : mixed
- setRouter() : mixed
- bootstrap() : void
- registerShutdownFunction() : void
- setContext() : mixed
- setDriverManager() : mixed
- setSchemaManager() : mixed
- setSession() : mixed
Properties
$config
The configuration loaded from the 'app' configuration group
protected
array<string|int, mixed>
$config
= []
$context
protected
IContext
$context
$dispatcher
protected
IDispatcher
$dispatcher
$driver_manager
protected
DriverManager
$driver_manager
$errors
protected
array<string|int, mixed>
$errors
= []
$event_dispatcher
protected
IEventDispatcher
$event_dispatcher
$instance
protected
static mixed
$instance
$kind
protected
string
$kind
Tags
$name
protected
string
$name
Tags
$notices
protected
array<string|int, mixed>
$notices
= []
$request
protected
IRequest
$request
$response
protected
IResponse
$response
$router
protected
IRouter
$router
$schema_manager
protected
SchemaManager
$schema_manager
$session
protected
ISession
$session
$warnings
protected
array<string|int, mixed>
$warnings
= []
$hashCode
private
int
$hashCode
$hashCounter
private
static int
$hashCounter
= 0
$profile_run_uri
private
Uri
$profile_run_uri
$temporary_directory
private
string
$temporary_directory
Methods
__call()
public
__call(string $method, array<string|int, mixed> $arguments) : mixed
Parameters
- $method : string
- $arguments : array<string|int, mixed>
Tags
__callStatic()
public
static __callStatic(mixed $method, array<string|int, mixed> $arguments) : mixed
Parameters
- $method : mixed
- $arguments : array<string|int, mixed>
__destruct()
public
__destruct() : mixed
__get()
public
__get(string $property) : mixed
Parameters
- $property : string
addError()
public
addError(string $error) : void
Parameters
- $error : string
Tags
addErrors()
public
addErrors(array<string|int, mixed> $errors) : void
Parameters
- $errors : array<string|int, mixed>
addNotice()
Add a notice to this application
public
addNotice(string $notice) : void
Parameters
- $notice : string
Tags
addNotices()
Add a set of notices to this application
public
addNotices(array<string|int, mixed> $notices) : void
Parameters
- $notices : array<string|int, mixed>
addRoute()
public
addRoute(IRoute $route) : mixed
Parameters
- $route : IRoute
Tags
addWarning()
Adds a warning to this application
public
addWarning(string $warning) : void
Parameters
- $warning : string
Tags
addWarnings()
Adds a set of warnings to this application
public
addWarnings(array<string|int, mixed> $warnings) : void
Parameters
- $warnings : array<string|int, mixed>
clearErrors()
Clears all existing errors within this application
public
clearErrors() : void
clearNotices()
Clears all existing notices within this application
public
clearNotices() : void
clearWarnings()
Clears all existing warnings within this application
public
clearWarnings() : void
execute()
{@inheritdoc}
public
execute(IMessage $request) : IResponse
Parameters
- $request : IMessage
Tags
Return values
IResponseextends()
public
extends(ReflectionClass $reflector) : bool
Parameters
- $reflector : ReflectionClass
Return values
boolgetConfig()
public
getConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>getContext()
public
getContext() : IContext
Tags
Return values
IContextgetDispatcher()
public
getDispatcher() : Dispatcher
Tags
Return values
DispatchergetDriverManager()
public
getDriverManager() : DriverManager
Return values
DriverManagergetErrors()
Gets all existing errors within this application
public
getErrors() : array<string|int, mixed>
Return values
array<string|int, mixed>getEventDispatcher()
public
getEventDispatcher() : IEventDispatcher
Return values
IEventDispatchergetInstance()
public
static getInstance() : IApplication
Return values
IApplicationgetKind()
Gets the kind of this application. Return value will be one of 'cli', 'api', 'site'
public
getKind() : string
Tags
Return values
stringgetName()
Gets the name of the application.
public
getName() : string
Tags
Return values
stringgetNotices()
Get all existing notices within this application
public
getNotices() : array<string|int, mixed>
Return values
array<string|int, mixed>getProfileNamespace()
public
getProfileNamespace() : string
Return values
stringgetProfileRunLink()
public
getProfileRunLink() : string
Return values
stringgetProfileRunUri()
public
getProfileRunUri() : Uri|null
Return values
Uri|nullgetReflection()
public
getReflection() : ReflectionClass
Return values
ReflectionClassgetRequest()
public
getRequest() : IRequest
Tags
Return values
IRequestgetResponse()
public
getResponse() : IResponse
Tags
Return values
IResponsegetRouter()
public
getRouter() : IRouter
Return values
IRoutergetSchemaManager()
public
getSchemaManager() : SchemaManager
Return values
SchemaManagergetSession()
public
getSession() : ISession
Return values
ISessiongetTemporaryDirectory()
public
getTemporaryDirectory() : string
Return values
stringgetVersion()
public
getVersion() : string
Return values
stringgetWarnings()
Gets all warnings within this application
public
getWarnings() : array<string|int, mixed>
Return values
array<string|int, mixed>isJournaling()
public
isJournaling() : bool
Return values
boolisProfiling()
public
isProfiling() : bool
Return values
boolredirect()
If the current application being run is of the kind 'api' or 'site' then an HTTP 'Location' header for a particular URI will be sent and execution will end. If however the application being run is of the kind 'cli' then execution will be redirected to another controller and action within the cli application
public
redirect(IUri|string $uri) : void
Parameters
- $uri : IUri|string
Tags
respond()
{@inheritdoc}
public
respond([mixed $message = null ]) : IResponse
Parameters
- $message : mixed = null
Tags
Return values
IResponsesetErrors()
public
setErrors( $errors) : void
Parameters
setNotices()
public
setNotices( $notices) : void
Parameters
setProfileRunUri()
public
setProfileRunUri(Uri $profile_run_uri) : mixed
Parameters
- $profile_run_uri : Uri
setWarnings()
public
setWarnings( $warnings) : void
Parameters
__construct()
protected
__construct(IContext $context) : mixed
Parameters
- $context : IContext
Tags
init()
{@inheritdoc}
protected
init() : mixed
Tags
logError()
Logs a message as an error
protected
logError(mixed $message) : void
Parameters
- $message : mixed
-
The message to log
onAfterExec()
protected
onAfterExec() : void
onBeforeExec()
protected
onBeforeExec() : void
setDispatcher()
protected
setDispatcher(IDispatcher $dispatcher) : mixed
Parameters
- $dispatcher : IDispatcher
setEventDispatcher()
protected
setEventDispatcher(IEventDispatcher $event_dispatcher) : mixed
Parameters
- $event_dispatcher : IEventDispatcher
setKind()
protected
setKind(string $kind) : mixed
Parameters
- $kind : string
setName()
protected
setName(string $name) : mixed
Parameters
- $name : string
setRequest()
protected
setRequest(IRequest $request) : mixed
Parameters
- $request : IRequest
Tags
setResponse()
protected
setResponse(IResponse $response) : mixed
Parameters
- $response : IResponse
Tags
setRouter()
protected
setRouter(IRouter $router) : mixed
Parameters
- $router : IRouter
Tags
bootstrap()
private
bootstrap() : void
registerShutdownFunction()
private
registerShutdownFunction() : void
setContext()
private
setContext(IContext $context) : mixed
Parameters
- $context : IContext
setDriverManager()
private
setDriverManager(DriverManager $driver_manager) : mixed
Parameters
- $driver_manager : DriverManager
setSchemaManager()
private
setSchemaManager(SchemaManager $schema_manager) : mixed
Parameters
- $schema_manager : SchemaManager
setSession()
private
setSession(ISession $session) : mixed
Parameters
- $session : ISession