Class JGithubPackageIssues

GitHub API Issues class for the Joomla Platform.

JGithubPackageIssues

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/issues
Located at joomla/github/package/issues.php

Methods summary

`public object`	# `create( string $user, string $repo, string $title, string $body = null, string $assignee = null, integer $milestone = null, array $labels = null )` Method to create an issue. Method to create an issue. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$title` `string` - $title The title of the new issue. `$body` `string` - $body The body text for the new issue. `$assignee` `string` - $assignee The login for the GitHub user that this issue should be assigned to. `$milestone` `integer` - $milestone The milestone to associate this issue with. `$labels` `array` - $labels The labels to associate with this issue. Returns `object` Throws `DomainException` Since 11.3
`public object`	# `edit( string $user, string $repo, integer $issueId, string $state = null, string $title = null, string $body = null, string $assignee = null, integer $milestone = null, array $labels = null )` Method to update an issue. Method to update an issue. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$issueId` `integer` - $issueId The issue number. `$state` `string` - $state The optional new state for the issue. [open, closed] `$title` `string` - $title The title of the new issue. `$body` `string` - $body The body text for the new issue. `$assignee` `string` - $assignee The login for the GitHub user that this issue should be assigned to. `$milestone` `integer` - $milestone The milestone to associate this issue with. `$labels` `array` - $labels The labels to associate with this issue. Returns `object` Throws `DomainException` Since 11.3
`public object`	# `get( string $user, string $repo, integer $issueId )` Method to get a single issue. Method to get a single issue. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$issueId` `integer` - $issueId The issue number. Returns `object` Throws `DomainException` Since 11.3
`public array`	# `getList( string $filter = null, string $state = null, string $labels = null, string $sort = null, string $direction = null, JDate $since = null, integer $page = 0, integer $limit = 0 )` Method to list an authenticated user's issues. Method to list an authenticated user's issues. Parameters `$filter` `string` - $filter The filter type: assigned, created, mentioned, subscribed. `$state` `string` - $state The optional state to filter requests by. [open, closed] `$labels` `string` - $labels The list of comma separated Label names. Example: bug,ui,@high. `$sort` `string` - $sort The sort order: created, updated, comments, default: created. `$direction` `string` - $direction The list direction: asc or desc, default: desc. `$since` `JDate` - $since The date/time since when issues should be returned. `$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`	# `getListByRepository( string $user, string $repo, string $milestone = null, string $state = null, string $assignee = null, string $mentioned = null, string $labels = null, string $sort = null, string $direction = null, JDate $since = null, integer $page = 0, integer $limit = 0 )` Method to list issues. Method to list issues. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$milestone` `string` - $milestone The milestone number, 'none', or . `$state` `string` - $state The optional state to filter requests by. [open, closed] `$assignee` `string` - $assignee The assignee name, 'none', or . `$mentioned` `string` - $mentioned The GitHub user name. `$labels` `string` - $labels The list of comma separated Label names. Example: bug,ui,@high. `$sort` `string` - $sort The sort order: created, updated, comments, default: created. `$direction` `string` - $direction The list direction: asc or desc, default: desc. `$since` `JDate` - $since The date/time since when issues should be returned. `$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 object`	# `createComment( string $user, string $repo, integer $issueId, string $body )` Method to create a comment on an issue. Method to create a comment on an issue. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$issueId` `integer` - $issueId The issue number. `$body` `string` - $body The comment body text. Returns `object` Since 11.3
`public object`	# `createLabel( string $user, string $repo, string $name, string $color )` Method to create a label on a repo. Method to create a label on a repo. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$name` `string` - $name The label name. `$color` `string` - $color The label color. Returns `object` Since 12.3
`public`	# `deleteComment( string $user, string $repo, integer $commentId )` Method to delete a comment on an issue. Method to delete a comment on an issue. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$commentId` `integer` - $commentId The id of the comment to delete. Since 11.3
`public object`	# `deleteLabel( string $user, string $repo, string $label )` Method to delete a label on a repo. Method to delete a label on a repo. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$label` `string` - $label The label name. Returns `object` Since 12.3
`public object`	# `editComment( string $user, string $repo, integer $commentId, string $body )` Method to update a comment on an issue. Method to update a comment on an issue. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$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`	# `editLabel( string $user, string $repo, string $label, string $name, string $color )` Method to update a label on a repo. Method to update a label on a repo. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$label` `string` - $label The label name. `$name` `string` - $name The label name. `$color` `string` - $color The label color. Returns `object` Since 12.3
`public object`	# `getComment( string $user, string $repo, integer $commentId )` Method to get a specific comment on an issue. Method to get a specific comment on an issue. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$commentId` `integer` - $commentId The comment id to get. Returns `object` Since 11.3
`public array`	# `getComments( string $user, string $repo, integer $issueId, integer $page = 0, integer $limit = 0 )` Method to get the list of comments on an issue. Method to get the list of comments on an issue. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$issueId` `integer` - $issueId The issue 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
`public object`	# `getLabel( string $user, string $repo, string $name )` Method to get a specific label on a repo. Method to get a specific label on a repo. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$name` `string` - $name The label name to get. Returns `object` Since 12.3
`public array`	# `getLabels( string $user, string $repo )` Method to get the list of labels on a repo. Method to get the list of labels on a repo. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. Returns `array` Since 12.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 JGithubPackageIssuesAssignees`	`$assignees`	# GitHub API object for assignees. GitHub API object for assignees.
`public read-only JGithubPackageIssuesComments`	`$comments`	# GitHub API object for comments. GitHub API object for comments.
`public read-only JGithubPackageIssuesEvents`	`$events`	# GitHub API object for events. GitHub API object for events.
`public read-only JGithubPackageIssuesLabels`	`$labels`	# GitHub API object for labels. GitHub API object for labels.
`public read-only JGithubPackageIssuesMilestones`	`$milestones`	# GitHub API object for milestones. GitHub API object for milestones.

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGithubPackageIssues

Methods summary

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

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