Class JGithubPackageGists

GitHub API Gists class for the Joomla Platform.

JGithubPackageGists

Package: Joomla\Platform\GitHub
Deprecated: 4.0 Use the joomla/github package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.3
Documentation: https://developer.github.com/v3/gists
Located at joomla/github/package/gists.php

Methods summary

`public object`	# `create( mixed $files, boolean $public = false, string $description = null )` Method to create a gist. Method to create a gist. Parameters `$files` `mixed` - $files Either an array of file paths or a single file path as a string. `$public` `boolean` - $public True if the gist should be public. `$description` `string` - $description The optional description of the gist. Returns `object` Throws `DomainException` Since 11.3
`public`	# `delete( integer $gistId )` Method to delete a gist. Method to delete a gist. Parameters `$gistId` `integer` - $gistId The gist number. Throws `DomainException` Since 11.3
`public object`	# `edit( integer $gistId, mixed $files = null, boolean $public = null, string $description = null )` Method to update a gist. Method to update a gist. Parameters `$gistId` `integer` - $gistId The gist number. `$files` `mixed` - $files Either an array of file paths or a single file path as a string. `$public` `boolean` - $public True if the gist should be public. `$description` `string` - $description The description of the gist. Returns `object` Throws `DomainException` Since 11.3
`public object`	# `fork( integer $gistId )` Method to fork a gist. Method to fork a gist. Parameters `$gistId` `integer` - $gistId The gist number. Returns `object` Throws `DomainException` Since 11.3
`public object`	# `get( integer $gistId )` Method to get a single gist. Method to get a single gist. Parameters `$gistId` `integer` - $gistId The gist number. Returns `object` Throws `DomainException` Since 11.3
`public array`	# `getList( integer $page = 0, integer $limit = 0 )` Method to list gists. If a user is authenticated it will return the user's gists, otherwise it will return all public gists. Method to list gists. If a user is authenticated it will return the user's gists, otherwise it will return all public gists. Parameters `$page` `integer` - $page The page number from which to get items. `$limit` `integer` - $limit The number of items on a page. Returns `array` Throws `DomainException` Since 11.3
`public array`	# `getListByUser( string $user, integer $page = 0, integer $limit = 0 )` Method to get a list of gists belonging to a given user. Method to get a list of gists belonging to a given user. Parameters `$user` `string` - $user The name of the GitHub user from which to list gists. `$page` `integer` - $page The page number from which to get items. `$limit` `integer` - $limit The number of items on a page. Returns `array` Throws `DomainException` Since 11.3
`public array`	# `getListPublic( integer $page = 0, integer $limit = 0 )` Method to get a list of all public gists. Method to get a list of all public gists. Parameters `$page` `integer` - $page The page number from which to get items. `$limit` `integer` - $limit The number of items on a page. Returns `array` Throws `DomainException` Since 11.3
`public array`	# `getListStarred( integer $page = 0, integer $limit = 0 )` Method to get a list of the authenticated users' starred gists. Method to get a list of the authenticated users' starred gists. Parameters `$page` `integer` - $page The page number from which to get items. `$limit` `integer` - $limit The number of items on a page. Returns `array` Throws `DomainException` Since 11.3
`public boolean`	# `isStarred( integer $gistId )` Method to check if a gist has been starred. Method to check if a gist has been starred. Parameters `$gistId` `integer` - $gistId The gist number. Returns `boolean` - True if the gist is starred. Throws `DomainException` Since 11.3
`public`	# `star( integer $gistId )` Method to star a gist. Method to star a gist. Parameters `$gistId` `integer` - $gistId The gist number. Throws `DomainException` Since 11.3
`public`	# `unstar( integer $gistId )` Method to star a gist. Method to star a gist. Parameters `$gistId` `integer` - $gistId The gist number. Throws `DomainException` Since 11.3
`protected array`	# `buildFileData( array $files )` Method to fetch a data array for transmitting to the GitHub API for a list of files based on an input array of file paths or filename and content pairs. Method to fetch a data array for transmitting to the GitHub API for a list of files based on an input array of file paths or filename and content pairs. Parameters `$files` `array` - $files The list of file paths or filenames and content. Returns `array` Throws `InvalidArgumentException` Since 11.3
`public object`	# `createComment( integer $gistId, string $body )` Method to create a comment on a gist. Method to create a comment on a gist. Parameters `$gistId` `integer` - $gistId The gist number. `$body` `string` - $body The comment body text. Returns `object` Since 11.3
`public`	# `deleteComment( integer $commentId )` Method to delete a comment on a gist. Method to delete a comment on a gist. Parameters `$commentId` `integer` - $commentId The id of the comment to delete. Since 11.3
`public object`	# `editComment( integer $commentId, string $body )` Method to update a comment on a gist. Method to update a comment on a gist. Parameters `$commentId` `integer` - $commentId The id of the comment to update. `$body` `string` - $body The new body text for the comment. Returns `object` Since 11.3
`public object`	# `getComment( integer $commentId )` Method to get a specific comment on a gist. Method to get a specific comment on a gist. Parameters `$commentId` `integer` - $commentId The comment id to get. Returns `object` Since 11.3
`public array`	# `getComments( integer $gistId, integer $page = 0, integer $limit = 0 )` Method to get the list of comments on a gist. Method to get the list of comments on a gist. Parameters `$gistId` `integer` - $gistId The gist number. `$page` `integer` - $page The page number from which to get items. `$limit` `integer` - $limit The number of items on a page. Returns `array` Since 11.3

Methods inherited from JGithubPackage

__get()

Methods inherited from JGithubObject

__construct(), fetchUrl(), processResponse()

Magic methods summary

Properties summary

`protected string`	`$name`	# Since 3.3 (CMS)
`protected array`	`$packages`	# Since 3.3 (CMS)

Properties inherited from JGithubObject

$client, $options

Magic properties

`public read-only JGithubPackageGistsComments`	`$comments`		# GitHub API object for gist comments. GitHub API object for gist comments.

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGithubPackageGists

Methods summary

Parameters

Returns

Throws

Since

Parameters

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Throws

Since

Parameters

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Methods inherited from JGithubPackage

Methods inherited from JGithubObject

Magic methods summary

Properties summary

Since

Since

Properties inherited from JGithubObject

Magic properties