JGithubPackageMarkdown
Extends \JGithubPackageGitHub API Markdown class.
| documentation | |
|---|---|
| since |
3.3 |
| deprecated |
4.0 Use the |
| package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JGithubHttp $client = null)
| since |
1.7.3 |
|---|
Arguments
- $options
\Joomla\Registry\RegistryGitHub options object.- $client
\JGithubHttpThe HTTP client object.
__get
Magic method to lazily create API objects
__get(string $name) : \JGithubPackage
| since |
3.3 |
|---|---|
| throws |
|
Arguments
- $name
stringName of property to retrieve
Response
\JGithubPackageGitHub API package object.
fetchUrl
Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.
fetchUrl(string $path, integer $page, integer $limit) : string
| since |
1.7.3 |
|---|
Arguments
- $path
stringURL to inflect- $page
integerPage to request- $limit
integerNumber of results to return per page
Response
stringThe request URL.
processResponse
Process the response and decode it.
processResponse(\JHttpResponse $response, integer $expectedCode = 200, boolean $decode = true) : mixed
| throws |
|
|---|---|
| since |
3.3.0 |
Arguments
- $response
\JHttpResponseThe response.- $expectedCode
integerThe expected "good" code.- $decode
booleanIf the should be response be JSON decoded.
Response
mixed
render
Method to render a markdown document.
render(string $text, string $mode = 'gfm', string $context = null) : string
| since |
3.3 |
|---|---|
| throws |
|
Arguments
- $text
stringThe text object being parsed.- $mode
stringThe parsing mode; valid options are 'markdown' or 'gfm'.- $context
stringAn optional repository context, only used in 'gfm' mode.
Response
stringFormatted HTML
Properties
name
| since |
3.3 |
|---|
Type(s)
string
packages
| since |
3.3 |
|---|
Type(s)
array
client
The HTTP client object to use in sending HTTP requests.