Documentation

CommitInfo
in package

FinalYes

Commit info.

Tags
author

Kitamura Satoshi with.no.parachute@gmail.com

Table of Contents

Properties

$author_email  : string|null
Author email.
$author_name  : string|null
Author name.
$committer_email  : string|null
Committer email.
$committer_name  : string|null
Committer name.
$date  : int|null
Commit message.
$id  : string|null
Commit ID.
$message  : string|null
Commit message.

Methods

getAuthorEmail()  : string|null
Return author email.
getAuthorName()  : string|null
Return author name.
getCommitterEmail()  : string|null
Return committer email.
getCommitterName()  : string|null
Return committer name.
getDate()  : int|null
Return commit date.
getId()  : string|null
Return commit ID.
getMessage()  : string|null
Return commit message.
setAuthorEmail()  : self
Set author email.
setAuthorName()  : self
Set author name.
setCommitterEmail()  : self
Set committer email.
setCommitterName()  : self
Set committer name.
setDate()  : self
Set commit date
setId()  : self
Set commit ID.
setMessage()  : self
Set commit message.
toArray()  : array<string|int, mixed>

Properties

$author_email

Author email.

private string|null $author_email = null

$author_name

Author name.

private string|null $author_name = null

$committer_email

Committer email.

private string|null $committer_email = null

$committer_name

Committer name.

private string|null $committer_name = null

$date

Commit message.

private int|null $date = null

$message

Commit message.

private string|null $message = null

Methods

getAuthorEmail()

Return author email.

public getAuthorEmail() : string|null
Return values
string|null

getAuthorName()

Return author name.

public getAuthorName() : string|null
Return values
string|null

getCommitterEmail()

Return committer email.

public getCommitterEmail() : string|null
Return values
string|null

getCommitterName()

Return committer name.

public getCommitterName() : string|null
Return values
string|null

getDate()

Return commit date.

public getDate() : int|null
Return values
int|null

getId()

Return commit ID.

public getId() : string|null
Return values
string|null

getMessage()

Return commit message.

public getMessage() : string|null
Return values
string|null

setAuthorEmail()

Set author email.

public setAuthorEmail(string $author_email) : self
Parameters
$author_email : string
Return values
self

setAuthorName()

Set author name.

public setAuthorName(string $author_name) : self
Parameters
$author_name : string
Return values
self

setCommitterEmail()

Set committer email.

public setCommitterEmail(string $committer_email) : self
Parameters
$committer_email : string
Return values
self

setCommitterName()

Set committer name.

public setCommitterName(string $committer_name) : self
Parameters
$committer_name : string
Return values
self

setDate()

Set commit date

public setDate(int $date) : self
Parameters
$date : int
Return values
self

setId()

Set commit ID.

public setId(string $id) : self
Parameters
$id : string
Return values
self

setMessage()

Set commit message.

public setMessage(string $message) : self
Parameters
$message : string
Return values
self

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

        
On this page

Search results