PHP Class Joli\SlackSecretSanta\SecretSanta

Show file Open project: jolicode/slack-secret-santa Class Usage Examples

Public Methods

Method	Description
__construct ( string $hash, array $associations, string $adminUserId, string $adminMessage = null )
addError ( string $error )
getAdminMessage ( ) : string
getAdminUserId ( ) : string
getAssociations ( ) : string[]
getErrors ( ) : string[]
getHash ( ) : string
getRemainingAssociations ( ) : string[]
isDone ( ) : boolean
markAssociationAsProceeded ( string $giver )

Method Details

__construct() public method

public __construct ( string $hash, array $associations, string $adminUserId, string $adminMessage = null )
$hash	string
$associations	array
$adminUserId	string
$adminMessage	string

addError() public method

public addError ( string $error )
$error	string

getAdminMessage() public method

public getAdminMessage ( ) : string
return	string

getAdminUserId() public method

public getAdminUserId ( ) : string
return	string

getAssociations() public method

public getAssociations ( ) : string[]
return	string[]

getErrors() public method

public getErrors ( ) : string[]
return	string[]

getHash() public method

public getHash ( ) : string
return	string

getRemainingAssociations() public method

public getRemainingAssociations ( ) : string[]
return	string[]

isDone() public method

public isDone ( ) : boolean
return	boolean

markAssociationAsProceeded() public method

public markAssociationAsProceeded ( string $giver )
$giver	string