class Client

Traits

Properties

protected $curl from CICommon
protected $api_url from CICommon

Methods

__construct(Curl $curl, string $api_url)

CICommon constructor.

from CICommon
mixed
listAllCodesOfConduct()

List all codes of conduct.

mixed
getCodeOfConduct(string $key)

Get an individual code of conduct.

mixed
getRepositoryCodeOfConduct(string $repo_full_name)

No description

mixed
getContentsOfRepositoryCodeOfConduct(string $repo_full_name)

Get the contents of a repository's code of conduct.

mixed
getEmojis()

Emojis.

listGitignore()

Listing available templates.

mixed
getGitignore(string $name = 'C')

Get a single template.

mixed
listLicenses()

List all licenses.

mixed
getLicense(string $name = 'mit')

Get an individual license.

mixed
getContentsOfRepositoryLicense(string $repo_full_name)

Get the contents of a repository's license.

mixed
RenderMarkdown(string $text, string $context, string $mode = 'markdown')

Render an arbitrary Markdown document.

mixed
RenderMarkdownRaw(string $content, string $content_type = 'text/plain')

Render a Markdown document in raw mode.

mixed
getMeta()

meta.

mixed
getRateLimit()

Get your current rate limit status.

Details

in CICommon at line 18
__construct(Curl $curl, string $api_url)

CICommon constructor.

Parameters

Curl $curl
string $api_url

at line 20
mixed listAllCodesOfConduct()

List all codes of conduct.

Return Value

mixed

Exceptions

Exception

at line 32
mixed getCodeOfConduct(string $key)

Get an individual code of conduct.

Parameters

string $key

Return Value

mixed

Exceptions

Exception

at line 42
mixed getRepositoryCodeOfConduct(string $repo_full_name)

Parameters

string $repo_full_name

Return Value

mixed

Exceptions

Exception

at line 54
mixed getContentsOfRepositoryCodeOfConduct(string $repo_full_name)

Get the contents of a repository's code of conduct.

Parameters

string $repo_full_name

Return Value

mixed

Exceptions

Exception

at line 70
mixed getEmojis()

Emojis.

Lists all the emojis available to use on GitHub.

Return Value

mixed

Exceptions

Exception

See also

at line 82
listGitignore()

Listing available templates.

Exceptions

Exception

See also

at line 94
mixed getGitignore(string $name = 'C')

Get a single template.

Parameters

string $name

Return Value

mixed

Exceptions

Exception

at line 106
mixed listLicenses()

List all licenses.

Return Value

mixed

Exceptions

Exception

at line 118
mixed getLicense(string $name = 'mit')

Get an individual license.

Parameters

string $name

Return Value

mixed

Exceptions

Exception

at line 130
mixed getContentsOfRepositoryLicense(string $repo_full_name)

Get the contents of a repository's license.

Parameters

string $repo_full_name

Return Value

mixed

Exceptions

Exception

at line 145
mixed RenderMarkdown(string $text, string $context, string $mode = 'markdown')

Render an arbitrary Markdown document.

Parameters

string $text
string $context
string $mode

Return Value

mixed

Exceptions

Exception

at line 163
mixed RenderMarkdownRaw(string $content, string $content_type = 'text/plain')

Render a Markdown document in raw mode.

Parameters

string $content
string $content_type

Return Value

mixed

Exceptions

Exception

at line 177
mixed getMeta()

meta.

Return Value

mixed

Exceptions

Exception

See also

at line 191
mixed getRateLimit()

Get your current rate limit status.

Return Value

mixed

Exceptions

Exception

See also