JGithubPackageDataTags

class JGithubPackageDataTags extends JGithubPackage

GitHub API Data Tags class for the Joomla Platform.

This tags API only deals with tag objects - so only annotated tags, not lightweight tags.

Methods

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

from JGithubObject
JGithubPackage
__get( string $name)

Magic method to lazily create API objects

from JGithubPackage
object
get( string $owner, string $repo, string $sha)

Get a Tag.

object
create( string $owner, string $repo, string $tag, string $message, string $object, string $type, string $tagger_name, string $tagger_email, string $tagger_date)

Create a Tag Object

Details

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

Parameters

Registry $options GitHub options object.
JGithubHttp $client The HTTP client object.

JGithubPackage __get( string $name)

Magic method to lazily create API objects

Parameters

string $name Name of property to retrieve

Return Value

JGithubPackage GitHub API package object.

Exceptions

RuntimeException

object get( string $owner, string $repo, string $sha)

Get a Tag.

Parameters

string $owner The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $sha The SHA1 value to set the reference to.

Return Value

object

object create( string $owner, string $repo, string $tag, string $message, string $object, string $type, string $tagger_name, string $tagger_email, string $tagger_date)

Create a Tag 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.

Parameters

string $owner The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $tag The tag string.
string $message The tag message.
string $object The SHA of the git object this is tagging.
string $type The type of the object we’re tagging. Normally this is a commit but it can also be a tree or a blob.
string $tagger_name The name of the author of the tag.
string $tagger_email The email of the author of the tag.
string $tagger_date Timestamp of when this object was tagged.

Return Value

object