Tags
Extends AbstractPackageGitHub API Data Tags class for the Joomla Framework.
This tags API only deals with tag objects - so only annotated tags, not lightweight tags.
link | |
---|---|
since |
1.0 |
package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) : mixed
since |
1.0 |
---|
Arguments
- options
\Joomla\Registry\Registry
GitHub options object.- client
\Joomla\Http\Http
The HTTP client object.
Response
mixed
__get
Magic method to lazily create API objects
__get(string name) : \Joomla\Github\AbstractPackage
since |
1.0 |
---|---|
throws |
|
Arguments
- name
string
Name of property to retrieve
Response
\Joomla\Github\AbstractPackage
GitHub 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 |
1.0 |
---|
Arguments
- owner
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- tag
string
The tag string.- message
string
The tag message.- object
string
The SHA of the git object this is tagging.- type
string
The type of the object we’re tagging. Normally this is a commit but it can also be a tree or a blob.- taggerName
string
The name of the author of the tag.- taggerEmail
string
The email of the author of the tag.- taggerDate
string
Timestamp 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, int page, int limit) : \Joomla\Uri\Uri
since |
1.0 |
---|
Arguments
- path
string
URL to inflect- page
int
Page to request- limit
int
Number of results to return per page
Response
\Joomla\Uri\Uri
get
Get a Tag.
get(string owner, string repo, string sha) : object
since |
1.0 |
---|
Arguments
- owner
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- sha
string
The SHA1 value to set the reference to.
Response
object
processResponse
Process the response and decode it.
processResponse(\Joomla\Http\Response response, int expectedCode = 200) : mixed
since |
1.0 |
---|---|
throws |
|
Arguments
- response
\Joomla\Http\Response
The response.- expectedCode
int
The expected "good" code.
Response
mixed
Properties
options
Options for the GitHub object.
since |
1.0 |
---|
Type(s)
\Joomla\Registry\Registry
client
The HTTP client object to use in sending HTTP requests.
since |
1.0 |
---|
Type(s)
\Joomla\Http\Http
package
The package the object resides in
since |
1.0 |
---|
Type(s)
string
hookEvents
Array containing the allowed hook events
since |
1.5.2 |
---|---|
link | |
note |
From 1.4.0 to 1.5.1 this was named $events, it was renamed due to naming conflicts with package subclasses |
Type(s)
array