PHP 클래스 TQ\Vcs\Repository\Transaction

파일 보기 프로젝트 열기: teqneers/php-stream-wrapper-for-git

보호된 프로퍼티들

프로퍼티 타입 설명
$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