PHP Класс TQ\Vcs\Repository\Transaction

Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$author string | null The author
$commitHash string | null The commit hash
$commitMsg string | null The commit message
$repository TQ\Vcs\Repository\RepositoryInterface The VCS repository
$result mixed The return value of the transactional callback

Открытые методы

Метод Описание
__construct ( TQ\Vcs\Repository\RepositoryInterface $repository ) Creates a new transactional parameter
getAuthor ( ) : string | null Returns the author that will be used when committing the transaction
getCommitHash ( ) : string | null Returns the hash identifying the commit
getCommitMsg ( ) : string | null Returns the commit message that will be used when committing the transaction
getRepository ( ) : TQ\Vcs\Repository\RepositoryInterface Returns the VCS repository
getRepositoryPath ( ) : string Returns the full file system path to the VCS repository
getResult ( ) : mixed Returns the return value of the closure executed in the transactional scope
resolvePath ( string $path ) : string Resolves a path relative to the repository into an absolute path
setAuthor ( string | null $author ) : Transaction Sets the author that will be used when committing the transaction
setCommitHash ( string $commitHash ) : Transaction Sets the hash identifying the commit
setCommitMsg ( string | null $commitMsg ) : Transaction Sets the commit message that will be used when committing the transaction
setResult ( mixed $result ) : Transaction Sets the return value of the closure executed in the transactional scope

Описание методов

__construct() публичный Метод

Creates a new transactional parameter
public __construct ( TQ\Vcs\Repository\RepositoryInterface $repository )
$repository TQ\Vcs\Repository\RepositoryInterface The VCS repository

getAuthor() публичный Метод

Returns the author that will be used when committing the transaction
public getAuthor ( ) : string | null
Результат string | null

getCommitHash() публичный Метод

Returns the hash identifying the commit
public getCommitHash ( ) : string | null
Результат string | null

getCommitMsg() публичный Метод

Returns the commit message that will be used when committing the transaction
public getCommitMsg ( ) : string | null
Результат string | null

getRepository() публичный Метод

Returns the VCS repository
public getRepository ( ) : TQ\Vcs\Repository\RepositoryInterface
Результат TQ\Vcs\Repository\RepositoryInterface

getRepositoryPath() публичный Метод

Returns the full file system path to the VCS repository
public getRepositoryPath ( ) : string
Результат string

getResult() публичный Метод

Returns the return value of the closure executed in the transactional scope
public getResult ( ) : mixed
Результат mixed

resolvePath() публичный Метод

Resolves a path relative to the repository into an absolute path
public resolvePath ( string $path ) : string
$path string The relative path to convert to an absolute path
Результат string

setAuthor() публичный Метод

Sets the author that will be used when committing the transaction
public setAuthor ( string | null $author ) : Transaction
$author string | null The author
Результат Transaction

setCommitHash() публичный Метод

Sets the hash identifying the commit
public setCommitHash ( string $commitHash ) : Transaction
$commitHash string The commit hash
Результат Transaction

setCommitMsg() публичный Метод

Sets the commit message that will be used when committing the transaction
public setCommitMsg ( string | null $commitMsg ) : Transaction
$commitMsg string | null The commit message
Результат Transaction

setResult() публичный Метод

Sets the return value of the closure executed in the transactional scope
public setResult ( mixed $result ) : Transaction
$result mixed The return value
Результат Transaction

Описание свойств

$author защищенное свойство

The author
protected string|null $author
Результат string | null

$commitHash защищенное свойство

The commit hash
protected string|null $commitHash
Результат string | null

$commitMsg защищенное свойство

The commit message
protected string|null $commitMsg
Результат string | null

$repository защищенное свойство

The VCS repository
protected RepositoryInterface,TQ\Vcs\Repository $repository
Результат TQ\Vcs\Repository\RepositoryInterface

$result защищенное свойство

The return value of the transactional callback
protected mixed $result
Результат mixed