Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JGithubGists
+ Graphe d'héritage de JGithubGists:
+ Graphe de collaboration de JGithubGists:

Liste de tous les membres

Fonctions membres publiques

 create ($files, $public=false, $description=null)
 createComment ($gistId, $body)
 delete ($gistId)
 deleteComment ($commentId)
 edit ($gistId, $files=null, $public=null, $description=null)
 editComment ($commentId, $body)
 fork ($gistId)
 get ($gistId)
 getComment ($commentId)
 getComments ($gistId, $page=0, $limit=0)
 getList ($page=0, $limit=0)
 getListByUser ($user, $page=0, $limit=0)
 getListPublic ($page=0, $limit=0)
 getListStarred ($page=0, $limit=0)
 isStarred ($gistId)
 star ($gistId)
 unstar ($gistId)
- Fonctions membres publiques inherited from JGithubObject
 __construct (JRegistry &$options=null, JGithubHttp $client=null)

Fonctions membres protégées

 buildFileData (array $files)
- Fonctions membres protégées inherited from JGithubObject
 fetchUrl ($path, $page=0, $limit=0)

Additional Inherited Members

- Attributs protégés inherited from JGithubObject
 $options
 $client

Documentation des fonctions membres

JGithubGists::buildFileData ( array  $files)
protected

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.

Paramètres:
array$filesThe list of file paths or filenames and content.
Renvoie:
array
Depuis:
11.3

Références $data, $file, $key, et elseif.

JGithubGists::create (   $files,
  $public = false,
  $description = null 
)

Method to create a gist.

Paramètres:
mixed$filesEither an array of file paths or a single file path as a string.
boolean$publicTrue if the gist should be public.
string$descriptionThe optional description of the gist.
Renvoie:
object
Depuis:
11.3

Références $data, $files, et $path.

JGithubGists::createComment (   $gistId,
  $body 
)

Method to create a comment on a gist.

Paramètres:
integer$gistIdThe gist number.
string$bodyThe comment body text.
Renvoie:
object
Depuis:
11.3

Références $data, et $path.

JGithubGists::delete (   $gistId)

Method to delete a gist.

Paramètres:
integer$gistIdThe gist number.
Renvoie:
void
Depuis:
11.3

Références $path.

JGithubGists::deleteComment (   $commentId)

Method to delete a comment on a gist.

Paramètres:
integer$commentIdThe id of the comment to delete.
Renvoie:
void
Depuis:
11.3

Références $path.

JGithubGists::edit (   $gistId,
  $files = null,
  $public = null,
  $description = null 
)

Method to update a gist.

Paramètres:
integer$gistIdThe gist number.
mixed$filesEither an array of file paths or a single file path as a string.
boolean$publicTrue if the gist should be public.
string$descriptionThe description of the gist.
Renvoie:
object
Depuis:
11.3

Références $data, $files, et $path.

JGithubGists::editComment (   $commentId,
  $body 
)

Method to update a comment on a gist.

Paramètres:
integer$commentIdThe id of the comment to update.
string$bodyThe new body text for the comment.
Renvoie:
object
Depuis:
11.3

Références $data, et $path.

JGithubGists::fork (   $gistId)

Method to fork a gist.

Paramètres:
integer$gistIdThe gist number.
Renvoie:
object
Depuis:
11.3

Références $path.

JGithubGists::get (   $gistId)

Method to get a single gist.

Paramètres:
integer$gistIdThe gist number.
Renvoie:
object
Depuis:
11.3

Références $path.

JGithubGists::getComment (   $commentId)

Method to get a specific comment on a gist.

Paramètres:
integer$commentIdThe comment id to get.
Renvoie:
object
Depuis:
11.3

Références $path.

JGithubGists::getComments (   $gistId,
  $page = 0,
  $limit = 0 
)

Method to get the list of comments on a gist.

Paramètres:
integer$gistIdThe gist number.
integer$pageThe page number from which to get items.
integer$limitThe number of items on a page.
Renvoie:
array
Depuis:
11.3

Références $limit, et $path.

JGithubGists::getList (   $page = 0,
  $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.

Paramètres:
integer$pageThe page number from which to get items.
integer$limitThe number of items on a page.
Renvoie:
array
Depuis:
11.3

Références $limit, et $path.

JGithubGists::getListByUser (   $user,
  $page = 0,
  $limit = 0 
)

Method to get a list of gists belonging to a given user.

Paramètres:
string$userThe name of the GitHub user from which to list gists.
integer$pageThe page number from which to get items.
integer$limitThe number of items on a page.
Renvoie:
array
Depuis:
11.3

Références $limit, $path, et $user.

JGithubGists::getListPublic (   $page = 0,
  $limit = 0 
)

Method to get a list of all public gists.

Paramètres:
integer$pageThe page number from which to get items.
integer$limitThe number of items on a page.
Renvoie:
array
Depuis:
11.3

Références $limit, et $path.

JGithubGists::getListStarred (   $page = 0,
  $limit = 0 
)

Method to get a list of the authenticated users' starred gists.

Paramètres:
integer$pageThe page number from which to get items.
integer$limitThe number of items on a page.
Renvoie:
array
Depuis:
11.3

Références $limit, et $path.

JGithubGists::isStarred (   $gistId)

Method to check if a gist has been starred.

Paramètres:
integer$gistIdThe gist number.
Renvoie:
boolean True if the gist is starred.
Depuis:
11.3

Références $path, et elseif.

JGithubGists::star (   $gistId)

Method to star a gist.

Paramètres:
integer$gistIdThe gist number.
Renvoie:
void
Depuis:
11.3

Références $path.

JGithubGists::unstar (   $gistId)

Method to star a gist.

Paramètres:
integer$gistIdThe gist number.
Renvoie:
void
Depuis:
11.3

Références $path.


La documentation de cette classe a été générée à partir du fichier suivant :