PHP Класс Api\V1\Engine\Api

Устаревший:
Наследование: extends KernelLoader, implements ApplicationInterface
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$content string

Открытые методы

Метод Описание
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

Приватные методы

Метод Описание
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

Описание методов

display() публичный Метод

public display ( ) : Response
Результат Symfony\Component\HttpFoundation\Response

initialize() публичный Метод

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

isAuthorized() публичный статический Метод

Default authentication
public static isAuthorized ( ) : boolean
Результат boolean

isValidRequestMethod() публичный статический Метод

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
Результат boolean

output() публичный статический Метод

Output the return
public static output ( integer $statusCode, array $data = null ) : boolean
$statusCode integer The status code.
$data array The data to return.
Результат boolean

Описание свойств

$content защищенное статическое свойство

protected static string $content
Результат string