PHP 클래스 yii\apidoc\templates\html\ApiRenderer

부터: 2.0
저자: Carsten Brandt ([email protected])
상속: extends yii\apidoc\renderers\ApiRenderer, implements yii\base\ViewContextInterface
파일 보기 프로젝트 열기: yiisoft/yii2-apidoc 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$indexView path or alias of the view file to use for rendering the index page.
$layout path or alias of the layout file to use.
$typeView path or alias of the view file to use for rendering types (classes, interfaces, traits).

공개 메소드들

메소드 설명
generateApiUrl ( $typeName )
getSourceUrl ( $type, $line = null )
getView ( ) : View
getViewPath ( )
init ( )
render ( Context $context, $targetDir ) Renders a given [[Context]].
renderClasses ( array $names ) : string
renderDefaultValue ( mixed $value ) : string Renders the default value.
renderInheritance ( yii\apidoc\models\ClassDoc $class ) : string
renderInterfaces ( array $names ) : string
renderMethodSignature ( yii\apidoc\models\MethodDoc $method, $context = null ) : string
renderPropertySignature ( PropertyDoc $property, $context = null ) : string
renderTraits ( array $names ) : string

보호된 메소드들

메소드 설명
generateFileName ( string $typeName ) : string Generates file name for API page for a given type
generateLink ( $text, $href, $options = [] )
renderWithLayout ( string $viewFile, array $params ) : string Renders file applying layout

메소드 상세

generateApiUrl() 공개 메소드

public generateApiUrl ( $typeName )

generateFileName() 보호된 메소드

Generates file name for API page for a given type
protected generateFileName ( string $typeName ) : string
$typeName string
리턴 string

getSourceUrl() 공개 메소드

public getSourceUrl ( $type, $line = null )

getView() 공개 메소드

public getView ( ) : View
리턴 yii\web\View the view instance

getViewPath() 공개 메소드

public getViewPath ( )

init() 공개 메소드

public init ( )

render() 공개 메소드

Renders a given [[Context]].
public render ( Context $context, $targetDir )
$context yii\apidoc\models\Context the api documentation context to render.
$targetDir

renderClasses() 공개 메소드

public renderClasses ( array $names ) : string
$names array
리턴 string

renderDefaultValue() 공개 메소드

Renders the default value.
부터: 2.1.1
public renderDefaultValue ( mixed $value ) : string
$value mixed
리턴 string

renderInheritance() 공개 메소드

public renderInheritance ( yii\apidoc\models\ClassDoc $class ) : string
$class yii\apidoc\models\ClassDoc
리턴 string

renderInterfaces() 공개 메소드

public renderInterfaces ( array $names ) : string
$names array
리턴 string

renderMethodSignature() 공개 메소드

public renderMethodSignature ( yii\apidoc\models\MethodDoc $method, $context = null ) : string
$method yii\apidoc\models\MethodDoc
리턴 string

renderPropertySignature() 공개 메소드

public renderPropertySignature ( PropertyDoc $property, $context = null ) : string
$property yii\apidoc\models\PropertyDoc
리턴 string

renderTraits() 공개 메소드

public renderTraits ( array $names ) : string
$names array
리턴 string

renderWithLayout() 보호된 메소드

Renders file applying layout
protected renderWithLayout ( string $viewFile, array $params ) : string
$viewFile string the view name
$params array the parameters (name-value pairs) that will be extracted and made available in the view file.
리턴 string

프로퍼티 상세

$indexView 공개적으로 프로퍼티

path or alias of the view file to use for rendering the index page.
public $indexView

$layout 공개적으로 프로퍼티

path or alias of the layout file to use.
public $layout

$typeView 공개적으로 프로퍼티

path or alias of the view file to use for rendering types (classes, interfaces, traits).
public $typeView