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:/Extension/GithubLocationExtension.php#37 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:/Extension/GithubLocationExtension.php#39

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

Source:/Extension/GithubLocationExtension.php#40

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

Source:/Extension/GithubLocationExtension.php#41

Methods

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

Source:/Extension/GithubLocationExtension.php#43

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

Source:

/Extension/GithubLocationExtension.php#60

Parameters:

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

private JuliusHaertl\PHPDocToRst\Extension\GithubLocationExtension::getGithubLink($file, $line=1, $branch=master)

Source:/Extension/GithubLocationExtension.php#77