Apex\App

Description

The central App class that contains all request information such as inputs, authenticated session and user, target resource, and more.

Target (Host, URI, Port, etc.)

• public getHost(): Get host being access.
• public getPort(): Get port being access.
• public getMethod(): Get HTTP method / verb being access.
• public getPath(): Get path / URI being access.
• public getPathOriginal(): Get original path / URI being access.
• public getContentType(): Get content type / URI being access.
• public getRequest(): Get the PSR7 ServerRequestInterface being access.
• public getUri(): Get the PSR7 UriInterface being access.
• public setPath(): Set path / URI being access.
• public setContentType(): Set content type being access.
• public setRequest(): Set the PSR7 ServerRequestInterface being access.

Client (IP and GeoIP, Authenticated User / Session, etc.)

• public getClient(): Get an instance of the ClientInfo object for this request.
• public isAuth(): Check whether or not user is authenticated.
• public getUuid(): Get UUID of authenticated user.
• public getUser(): Get instance of ArmorUserInterface class of authenticated user.
• public getSession(): Get UUID of authenticated user.
• public getArea(): Get the area currenctly being accessed
• public setUuid(): Set the UUID from the duration of this request.
• public setUser(): Set the user object for the duration of this request.
• public setSession(): Set the authenticated session for the duration of this request.
• public setArea(): Set the area for the duration of this request.

Miscallaneous Methods

• public getAction(): Shorthand to retrive the value of the 'submit' form field.
• public getContainer(): Get the PSR11 compliant container.
• public bootEloquent(): SMust be executed to utilize Eloquent functionality.
• public getInstanceName(): SGet the instance name of this system within the cluster.
• public isSlave(): Whether or not this system is a slave within the cluster.
• public getRoutesConfig(): SParse and return contents of YAML file within /boot/ directory
• public handle(): Handle the request according to PSR15 standards.
• public outputResponse(): Output a PSR7 ResponseInterface object to client.

Request Inputs

POST Inputs

GET Inputs

REQUEST Inputs

Cookies

Dynamic Path Parameters

Uploaded Files

SERVER