PHP Class Api\V1\Engine\Api

Deprecation:

Inheritance: extends KernelLoader, implements ApplicationInterface

Protected Properties

Property	Type	Description
$content	string

Method	Description
display ( ) : Response
initialize ( )	Initializes the entire API; extract class+method from the request, call, and output.
isAuthorized ( ) : boolean	Default authentication
isValidRequestMethod ( string $method ) : boolean	This is called in backend/modules//engine/api.php to limit certain calls to a given request method.
output ( integer $statusCode, array $data = null ) : boolean	Output the return

Method	Description
arrayToXML ( mixed &$input, string $key, DOMElement $XML )	Callback-method for elements in the return-array
getHeaderMessage ( $statusCode ) : string	Get the relevant HTTP status message
outputJSON ( integer $statusCode, array $data = null )	Output as JSON
outputXML ( integer $statusCode, array $data = null )	Output as XML

public display ( ) : Response
return	Symfony\Component\HttpFoundation\Response

This method exists because the service container needs to be set before the rest of API functionality gets loaded.

public initialize ( )

Default authentication

public static isAuthorized ( ) : boolean
return	boolean

This is called in backend/modules//engine/api.php to limit certain calls to a given request method.

public static isValidRequestMethod ( string $method ) : boolean
$method	string
return	boolean

Output the return

public static output ( integer $statusCode, array $data = null ) : boolean
$statusCode	integer	The status code.
$data	array	The data to return.
return	boolean

protected static string $content
return	string