Documentation

Site extends Application
in package
implements ISite

AbstractYes
Tags
author

Ramone Burrell ramone@ramoneburrell.com

abstract
since

Version 0.1.0

Table of Contents

Interfaces

ISite

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
$tmpl  : mixed
$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()  : mixed
{@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
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 = []

Methods

__callStatic()

public static __callStatic(mixed $method, array<string|int, mixed> $arguments) : mixed
Parameters
$method : mixed
$arguments : array<string|int, mixed>

__get()

public __get(string $property) : mixed
Parameters
$property : string

addErrors()

public addErrors(array<string|int, mixed> $errors) : void
Parameters
$errors : array<string|int, mixed>

addNotices()

Add a set of notices to this application

public addNotices(array<string|int, mixed> $notices) : void
Parameters
$notices : array<string|int, mixed>

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

extends()

public extends(ReflectionClass $reflector) : bool
Parameters
$reflector : ReflectionClass
Return values
bool

getConfig()

public getConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>

getErrors()

Gets all existing errors within this application

public getErrors() : array<string|int, mixed>
Return values
array<string|int, mixed>

getNotices()

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
string
public getProfileRunLink() : string
Return values
string

getReflection()

public getReflection() : ReflectionClass
Return values
ReflectionClass

getTemporaryDirectory()

public getTemporaryDirectory() : string
Return values
string

getWarnings()

Gets all warnings within this application

public getWarnings() : array<string|int, mixed>
Return values
array<string|int, mixed>

redirect()

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
see
Application::redirect()

setProfileRunUri()

public setProfileRunUri(Uri $profile_run_uri) : mixed
Parameters
$profile_run_uri : Uri

setWarnings()

public setWarnings( $warnings) : void
Parameters
$warnings :

logError()

Logs a message as an error

protected logError(mixed $message) : void
Parameters
$message : mixed

The message to log

setKind()

protected setKind(string $kind) : mixed
Parameters
$kind : string

setName()

protected setName(string $name) : mixed
Parameters
$name : string

        
On this page

Search results