PHP Class Bart\GitHook\GitHookConfig

Inheritance: extends Bart\Configuration\ProjectConfiguration
Datei anzeigen Open project: box/bart Class Usage Examples

Public Methods

Method Description
README ( ) : string
getEmergencyNotificationBody ( ) : string
getEmergencyNotificationEmailAddress ( ) : string
getEmergencyNotificationSubject ( ) : string
getPostReceiveHookActions ( ) : string[]
getPreReceiveHookActions ( ) : string[]
getValidRefs ( ) : string[]
jiraCommentTemplate ( ) : string

Method Details

README() public method

public README ( ) : string
return string Sample of how configuration is intended to be defined

getEmergencyNotificationBody() public method

public getEmergencyNotificationBody ( ) : string
return string body to send in notification email

getEmergencyNotificationEmailAddress() public method

public getEmergencyNotificationEmailAddress ( ) : string
return string email address to send notifications to

getEmergencyNotificationSubject() public method

public getEmergencyNotificationSubject ( ) : string
return string subject to send notification email with

getPostReceiveHookActions() public method

public getPostReceiveHookActions ( ) : string[]
return string[] List of FQCN's of each GitHookAction to be run on post-receive

getPreReceiveHookActions() public method

public getPreReceiveHookActions ( ) : string[]
return string[] List of FQCN's of each GitHookAction to be run on pre-receive

getValidRefs() public method

public getValidRefs ( ) : string[]
return string[] List of refs to run git hooks on

jiraCommentTemplate() public method

public jiraCommentTemplate ( ) : string
return string Template string to be sent to sprintf