PHP 클래스 Dingo\Blueprint\Blueprint

파일 보기 프로젝트 열기: dingo/blueprint 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$files Illuminate\Filesystem\Filesystem Filesytsem instance.
$includePath string Include path for documentation files.
$reader Doctrine\Common\Annotations\SimpleAnnotationReader Simple annotation reader instance.

공개 메소드들

메소드 설명
__construct ( Doctrine\Common\Annotations\SimpleAnnotationReader $reader, Illuminate\Filesystem\Filesystem $files ) : void Create a new generator instance.
generate ( Collection $controllers, string $name, string $version, string $includePath ) : boolean Generate documentation with the name and version.

보호된 메소드들

메소드 설명
appendAttributes ( string &$contents, Collection $attributes, integer $indent ) : void Append the attributes subsection to a resource or action.
appendBody ( string &$contents, string $body ) : void Append a body subsection to an action.
appendHeaders ( string &$contents, array $headers ) : void Append a headers subsection to an action.
appendParameters ( string &$contents, Collection $parameters ) : void Append the parameters subsection to a resource or action.
appendRequest ( string &$contents, Dingo\Blueprint\Annotation\Request $request, Resource $resource ) : void Append a request subsection to an action.
appendResponse ( string &$contents, Dingo\Blueprint\Annotation\Response $response, Resource $resource ) : void Append a response subsection to an action.
appendSection ( string &$contents, string $name, integer $indent, integer $lines = 2 ) : void Append a subsection to an action.
generateContentsFromResources ( Collection $resources, string $name ) : string Generate the documentation contents from the resources collection.
getFormat ( ) : string Get the API Blueprint format.
line ( integer $repeat = 1 ) : string Create a new line character.
prepareBody ( string $body, string $contentType ) : string Prepare a body.
registerAnnotationLoader ( ) : void Register the annotation loader.
tab ( integer $repeat = 1 ) : string Create a tab character.

메소드 상세

__construct() 공개 메소드

Create a new generator instance.
public __construct ( Doctrine\Common\Annotations\SimpleAnnotationReader $reader, Illuminate\Filesystem\Filesystem $files ) : void
$reader Doctrine\Common\Annotations\SimpleAnnotationReader
$files Illuminate\Filesystem\Filesystem
리턴 void

appendAttributes() 보호된 메소드

Append the attributes subsection to a resource or action.
protected appendAttributes ( string &$contents, Collection $attributes, integer $indent ) : void
$contents string
$attributes Illuminate\Support\Collection
$indent integer
리턴 void

appendBody() 보호된 메소드

Append a body subsection to an action.
protected appendBody ( string &$contents, string $body ) : void
$contents string
$body string
리턴 void

appendHeaders() 보호된 메소드

Append a headers subsection to an action.
protected appendHeaders ( string &$contents, array $headers ) : void
$contents string
$headers array
리턴 void

appendParameters() 보호된 메소드

Append the parameters subsection to a resource or action.
protected appendParameters ( string &$contents, Collection $parameters ) : void
$contents string
$parameters Illuminate\Support\Collection
리턴 void

appendRequest() 보호된 메소드

Append a request subsection to an action.
protected appendRequest ( string &$contents, Dingo\Blueprint\Annotation\Request $request, Resource $resource ) : void
$contents string
$request Dingo\Blueprint\Annotation\Request
$resource Resource
리턴 void

appendResponse() 보호된 메소드

Append a response subsection to an action.
protected appendResponse ( string &$contents, Dingo\Blueprint\Annotation\Response $response, Resource $resource ) : void
$contents string
$response Dingo\Blueprint\Annotation\Response
$resource Resource
리턴 void

appendSection() 보호된 메소드

Append a subsection to an action.
protected appendSection ( string &$contents, string $name, integer $indent, integer $lines = 2 ) : void
$contents string
$name string
$indent integer
$lines integer
리턴 void

generate() 공개 메소드

Generate documentation with the name and version.
public generate ( Collection $controllers, string $name, string $version, string $includePath ) : boolean
$controllers Illuminate\Support\Collection
$name string
$version string
$includePath string
리턴 boolean

generateContentsFromResources() 보호된 메소드

Generate the documentation contents from the resources collection.
protected generateContentsFromResources ( Collection $resources, string $name ) : string
$resources Illuminate\Support\Collection
$name string
리턴 string

getFormat() 보호된 메소드

Get the API Blueprint format.
protected getFormat ( ) : string
리턴 string

line() 보호된 메소드

Create a new line character.
protected line ( integer $repeat = 1 ) : string
$repeat integer
리턴 string

prepareBody() 보호된 메소드

Prepare a body.
protected prepareBody ( string $body, string $contentType ) : string
$body string
$contentType string
리턴 string

registerAnnotationLoader() 보호된 메소드

Register the annotation loader.
protected registerAnnotationLoader ( ) : void
리턴 void

tab() 보호된 메소드

Create a tab character.
protected tab ( integer $repeat = 1 ) : string
$repeat integer
리턴 string

프로퍼티 상세

$files 보호되어 있는 프로퍼티

Filesytsem instance.
protected Filesystem,Illuminate\Filesystem $files
리턴 Illuminate\Filesystem\Filesystem

$includePath 보호되어 있는 프로퍼티

Include path for documentation files.
protected string $includePath
리턴 string

$reader 보호되어 있는 프로퍼티

Simple annotation reader instance.
protected SimpleAnnotationReader,Doctrine\Common\Annotations $reader
리턴 Doctrine\Common\Annotations\SimpleAnnotationReader