PHP 클래스 PHPDocMD\Generator

저자: Evert Pot (https://evertpot.coom/)

보호된 프로퍼티들

프로퍼티	타입	설명
$apiIndexFile	string	Filename for API Index.
$classDefinitions	array	The list of classes and interfaces.
$linkTemplate	string	A simple template for generating links.
$outputDir	string	Output directory.
$templateDir	string	Directory containing the twig templates.

공개 메소드들

메소드	설명
__construct ( array $classDefinitions, string $outputDir, string $templateDir, string $linkTemplate = '%c.md', string $apiIndexFile = 'ApiIndex.md' )
classLink ( string $className, null \| string $label = null ) : string	This is a twig template function.
run ( )	Starts the generator.

보호된 메소드들

메소드	설명
createIndex ( ) : array	Creates an index of classes and namespaces.

메소드 상세

__construct() 공개 메소드

public __construct ( array $classDefinitions, string $outputDir, string $templateDir, string $linkTemplate = '%c.md', string $apiIndexFile = 'ApiIndex.md' )
$classDefinitions	array
$outputDir	string
$templateDir	string
$linkTemplate	string
$apiIndexFile	string

classLink() 정적인 공개 메소드

This function allows us to easily link classes to their existing pages. Due to the unfortunate way twig works, this must be static, and we must use a global to achieve our goal.

static public classLink ( string $className, null \| string $label = null ) : string
$className	string
$label	null \| string
리턴	string

createIndex() 보호된 메소드

I'm generating the actual markdown output here, which isn't great...But it will have to do. If I don't want to make things too complicated.

protected createIndex ( ) : array
리턴	array

run() 공개 메소드

Starts the generator.

public run ( )

프로퍼티 상세

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

Filename for API Index.

protected string $apiIndexFile
리턴	string

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

The list of classes and interfaces.

protected array $classDefinitions
리턴	array

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

A simple template for generating links.

protected string $linkTemplate
리턴	string

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

Output directory.

protected string $outputDir
리턴	string

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

Directory containing the twig templates.

protected string $templateDir
리턴	string