JGithubPackageMarkdown

class JGithubPackageMarkdown extends JGithubPackage

GitHub API Markdown class.

Methods

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

from JGithubObject
JGithubPackage
__get( string $name)

Magic method to lazily create API objects

from JGithubPackage
string
render( string $text, string $mode = 'gfm', string $context = null)

Method to render a markdown document.

Details

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

Parameters

Registry $options GitHub options object.
JGithubHttp $client The HTTP client object.

JGithubPackage __get( string $name)

Magic method to lazily create API objects

Parameters

string $name Name of property to retrieve

Return Value

JGithubPackage GitHub API package object.

Exceptions

RuntimeException

string render( string $text, string $mode = 'gfm', string $context = null)

Method to render a markdown document.

Parameters

string $text The text object being parsed.
string $mode The parsing mode; valid options are 'markdown' or 'gfm'.
string $context An optional repository context, only used in 'gfm' mode.

Return Value

string Formatted HTML

Exceptions

DomainException
InvalidArgumentException