JGithubPackageDataTags
Extends \JGithubPackageGitHub API Data Tags class for the Joomla Platform.
This tags API only deals with tag objects - so only annotated tags, not lightweight tags.
| documentation | |
|---|---|
| since |
1.7.3 |
| deprecated |
4.0 Use the |
| package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JGithubHttp $client = null)
| since |
1.7.3 |
|---|
Arguments
- $options
\Joomla\Registry\RegistryGitHub options object.- $client
\JGithubHttpThe HTTP client object.
__get
Magic method to lazily create API objects
__get(string $name) : \JGithubPackage
| since |
3.3 |
|---|---|
| throws |
|
Arguments
- $name
stringName of property to retrieve
Response
\JGithubPackageGitHub API package object.
create
Create a Tag Object
create(string $owner, string $repo, string $tag, string $message, string $object, string $type, string $taggerName, string $taggerEmail, string $taggerDate) : object
Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you simply have to create the reference - this call would be unnecessary.
| since |
3.3 |
|---|
Arguments
- $owner
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $tag
stringThe tag string.- $message
stringThe tag message.- $object
stringThe SHA of the git object this is tagging.- $type
stringThe type of the object we’re tagging. Normally this is a commit but it can also be a tree or a blob.- $taggerName
stringThe name of the author of the tag.- $taggerEmail
stringThe email of the author of the tag.- $taggerDate
stringTimestamp of when this object was tagged.
Response
object
fetchUrl
Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.
fetchUrl(string $path, integer $page, integer $limit) : string
| since |
1.7.3 |
|---|
Arguments
- $path
stringURL to inflect- $page
integerPage to request- $limit
integerNumber of results to return per page
Response
stringThe request URL.
get
Get a Tag.
get(string $owner, string $repo, string $sha) : object
| since |
3.3 |
|---|
Arguments
- $owner
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $sha
stringThe SHA1 value to set the reference to.
Response
object
processResponse
Process the response and decode it.
processResponse(\JHttpResponse $response, integer $expectedCode = 200, boolean $decode = true) : mixed
| throws |
|
|---|---|
| since |
3.3.0 |
Arguments
- $response
\JHttpResponseThe response.- $expectedCode
integerThe expected "good" code.- $decode
booleanIf the should be response be JSON decoded.
Response
mixed
Properties
name
| since |
3.3 |
|---|
Type(s)
string
packages
| since |
3.3 |
|---|
Type(s)
array
client
The HTTP client object to use in sending HTTP requests.