PHP Класс Mpociot\ApiDoc\Generators\AbstractGenerator

Показать файл Открыть проект Примеры использования класса

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

Метод Описание
callRoute ( string $method, string $uri, array $parameters = [], array $cookies = [], array $files = [], array $server = [], string $content = null ) : Illuminate\Http\Response Call the given URI and return the Response.
prepareMiddleware ( boolean $disable = false ) : void Prepares / Disables route middlewares.
processRoute ( Illuminate\Routing\Route $route, array $bindings = [], boolean $withResponse = true ) : array

Защищенные методы

Метод Описание
addRouteModelBindings ( $route, array $bindings ) : mixed
fancyImplode ( array $arr, string $first, string $last ) : string
getParameters ( array $routeData, array $routeAction, array $bindings ) : mixed
getRouteDescription ( Illuminate\Routing\Route $route ) : string
getRouteGroup ( string $route ) : string
getRouteResponse ( $route, $bindings, $headers = [] ) : Illuminate\Http\Response
getRouteRules ( $route, array $bindings ) : array
getUri ( $route ) : mixed
normalizeRule ( string $rule ) : string Normalizes a rule so that we can accept short types.
parseParameters ( string $rule, string $parameter ) : array Parse a parameter list.
parseRule ( string $rule, string $ruleName, array &$attributeData, integer $seed ) : void
parseStringRule ( string $rules ) : array Parse a string based rule.
splitValuePairs ( $parameters, $first = 'is ', $last = 'or ' )
transformHeadersToServerVars ( array $headers ) : array Transform headers array to array of $_SERVER vars with HTTP_* format.

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

addRouteModelBindings() защищенный Метод

protected addRouteModelBindings ( $route, array $bindings ) : mixed
$route
$bindings array
Результат mixed

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

Call the given URI and return the Response.
abstract public callRoute ( string $method, string $uri, array $parameters = [], array $cookies = [], array $files = [], array $server = [], string $content = null ) : Illuminate\Http\Response
$method string
$uri string
$parameters array
$cookies array
$files array
$server array
$content string
Результат Illuminate\Http\Response

fancyImplode() защищенный Метод

protected fancyImplode ( array $arr, string $first, string $last ) : string
$arr array
$first string
$last string
Результат string

getParameters() защищенный Метод

protected getParameters ( array $routeData, array $routeAction, array $bindings ) : mixed
$routeData array
$routeAction array
$bindings array
Результат mixed

getRouteDescription() защищенный Метод

protected getRouteDescription ( Illuminate\Routing\Route $route ) : string
$route Illuminate\Routing\Route
Результат string

getRouteGroup() защищенный Метод

protected getRouteGroup ( string $route ) : string
$route string
Результат string

getRouteResponse() защищенный Метод

protected getRouteResponse ( $route, $bindings, $headers = [] ) : Illuminate\Http\Response
$route
$bindings
$headers
Результат Illuminate\Http\Response

getRouteRules() защищенный Метод

protected getRouteRules ( $route, array $bindings ) : array
$route
$bindings array
Результат array

getUri() абстрактный защищенный Метод

abstract protected getUri ( $route ) : mixed
$route
Результат mixed

normalizeRule() защищенный Метод

Normalizes a rule so that we can accept short types.
protected normalizeRule ( string $rule ) : string
$rule string
Результат string

parseParameters() защищенный Метод

Parse a parameter list.
protected parseParameters ( string $rule, string $parameter ) : array
$rule string
$parameter string
Результат array

parseRule() защищенный Метод

protected parseRule ( string $rule, string $ruleName, array &$attributeData, integer $seed ) : void
$rule string
$ruleName string
$attributeData array
$seed integer
Результат void

parseStringRule() защищенный Метод

Parse a string based rule.
protected parseStringRule ( string $rules ) : array
$rules string
Результат array

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

Prepares / Disables route middlewares.
abstract public prepareMiddleware ( boolean $disable = false ) : void
$disable boolean
Результат void

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

abstract public processRoute ( Illuminate\Routing\Route $route, array $bindings = [], boolean $withResponse = true ) : array
$route Illuminate\Routing\Route
$bindings array
$withResponse boolean
Результат array

splitValuePairs() защищенный Метод

protected splitValuePairs ( $parameters, $first = 'is ', $last = 'or ' )

transformHeadersToServerVars() защищенный Метод

Transform headers array to array of $_SERVER vars with HTTP_* format.
protected transformHeadersToServerVars ( array $headers ) : array
$headers array
Результат array