JGithubPackageGitignore

class JGithubPackageGitignore extends JGithubPackage

GitHub API Gitignore class for the Joomla Platform.

The .gitignore Templates API lists and fetches templates from the GitHub .gitignore repository.

Methods

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

Constructor.

from JGithubObject
JGithubPackage
__get( string $name)

Magic method to lazily create API objects

from JGithubPackage
object
getList()

Listing available templates

mixed|string
get( string $name, boolean $raw = false)

Get a single template

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

object getList()

Listing available templates

List all templates available to pass as an option when creating a repository.

Return Value

object

mixed|string get( string $name, boolean $raw = false)

Get a single template

Parameters

string $name The name of the template
boolean $raw Raw output

Return Value

mixed|string

Exceptions

DomainException