Orpheus

RestApiWadlController extends HttpController

in package

• orpheus

Class RestApiWadlController

Table of Contents

Constants

ATTR_ID  = 'id'

ATTR_MEDIA_TYPE  = 'mediaType'

ATTR_NAME  = 'name'

ATTR_PATH  = 'path'

ATTR_REQUIRED  = 'required'

ATTR_STATUS  = 'status'

ATTR_STYLE  = 'style'

ATTR_TITLE  = 'title'

ENDPOINT_URL  = WEB_ROOT . 'api'

MIMETYPE_JSON  = 'application/json'

OPTION_PAGE_DESCRIPTION  = 'pageDescription'

OPTION_PAGE_TITLE  = 'pageTitle'

TAG_DOC  = 'doc'

TAG_METHOD  = 'method'

TAG_PARAM  = 'param'

TAG_REPRESENTATION  = 'representation'

TAG_REQUEST  = 'request'

TAG_RESOURCE  = 'resource'

TAG_RESOURCE_LIST  = 'resources'

TAG_RESPONSE  = 'response'

Properties

$catchControllerOutput  : bool

Catch controller output when running it

$options  : array<string|int, mixed>

Running options for this controller

$route  : ControllerRoute|null

The route calling this controller A controller could be called without any route and any request This variable comes to get the route without any request

$api  : object

$entityActions  : array<string|int, RestRouteGenerator>

$entityResPath  : string

$itemActions  : array<string|int, RestRouteGenerator>

$itemResPath  : string

$request  : InputRequest|null

The request calling this controller

Methods

__construct()  : mixed

Controller constructor

__toString()  : string

Get this controller as string

fillValues()  : void

Fill array with default values

getApi()  : object

getCurrentUrl()  : string

getOption()  : string|mixed

Get an option by $key

getRequest()  : InputRequest|null

Get the request

getRoute()  : ControllerRoute|null

Get the route

getRouteName()  : string|null

Get the route name

getValues()  : array<string|int, mixed>

Get parameter values of this controller Use it to generate routes (as for menus) with path parameters & you can get the current context

postRun()  : OutputResponse|null

After running the controller

prepare()  : OutputResponse|null

Prepare environment for this route

preRun()  : OutputResponse|null

Before running controller

preRun()  : HttpResponse|null

Before running controller

process()  : OutputResponse|null

Process the $request

processException()  : HttpResponse

processUserException()  : mixed

Process the given UserException

render()  : mixed

Render the given $layout in $response using $values

renderHtml()  : HtmlHttpResponse

Render the given $layout with $values

run()  : XmlHttpResponse

Run this controller

run()  : HttpResponse

Run this controller

setOption()  : AbstractController

Set an option by $key

setOptions()  : AbstractController

Set an option by $key

addAllEntityResources()  : void

addEntityResource()  : SimpleXMLElement|null

addJsonRepresentation()  : void

addResource()  : SimpleXMLElement|null

addResponse()  : void

addTitle()  : void

concatSlug()  : string

convertKeyToName()  : string

redirectToSelf()  : RedirectHttpResponse