PHP Класс PHPDocMD\Generator

Автор: Evert Pot (https://evertpot.coom/)

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

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

Свойство	Тип	Описание
$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