GithubLocationExtension

class JuliusHaertl\PHPDocToRst\Extension\GithubLocationExtension

This extension adds a link to the source at github to all elements

Arguments

0 => Url to the github repo (required)

1 => Path to the git repository (required)

2 => Branch to link to (default=master)

Source:src/Extension/GithubLocationExtension.php#40 Parent:JuliusHaertl\PHPDocToRst\Extension\Extension

Summary

Methods

• public prepare()
• public render($type, $builder, $element)
• private getGithubLink($file, $line, $branch)

Properties

protected static property JuliusHaertl\PHPDocToRst\Extension\GithubLocationExtension::$basePath

Source:src/Extension/GithubLocationExtension.php#42

protected static property JuliusHaertl\PHPDocToRst\Extension\GithubLocationExtension::$githubRepo

Source:src/Extension/GithubLocationExtension.php#43

protected static property JuliusHaertl\PHPDocToRst\Extension\GithubLocationExtension::$branch

Source:src/Extension/GithubLocationExtension.php#44

Methods

public JuliusHaertl\PHPDocToRst\Extension\GithubLocationExtension::prepare()

Source:src/Extension/GithubLocationExtension.php#46

public JuliusHaertl\PHPDocToRst\Extension\GithubLocationExtension::render($type, &$builder, $element)

Source:

src/Extension/GithubLocationExtension.php#62

Parameters:

• $type (string)
• $builder (JuliusHaertl\PHPDocToRst\Builder\FileBuilder)
• $element (phpDocumentor\Reflection\Element)