PHP Class InvitationModel, vanilla

Inheritance: extends Model

Show file Open project: vanilla/vanilla Class Usage Examples

Public Methods

Method	Description
__construct ( )	Class constructor. Defines the related database table name.
delete ( string \| unknown_type $InvitationID ) : boolean
getByInvitationID ( $InvitationID ) : array \| boolean \| stdClass
getByUserID ( $UserID, string $InvitationID = '', integer $Limit = 50, integer $Offset ) : Gdn_DataSet
save ( array $FormPostValues, array \| boolean $UserModel, array $Options = [] ) : boolean
send ( $InvitationID )

Protected Methods

Method	Description
getInvitationCode ( )	Returns a unique 8 character invitation code.

Method Details

__construct() public method

Class constructor. Defines the related database table name.

public __construct ( )

delete() public method

public delete ( string \| unknown_type $InvitationID ) : boolean
$InvitationID	string \| unknown_type
return	boolean

getByInvitationID() public method

public getByInvitationID ( $InvitationID ) : array \| boolean \| stdClass
$InvitationID
return	array \| boolean \| stdClass

getByUserID() public method

public getByUserID ( $UserID, string $InvitationID = '', integer $Limit = 50, integer $Offset ) : Gdn_DataSet
$UserID
$InvitationID	string
$Limit	integer
$Offset	integer
return	Gdn_DataSet

getInvitationCode() protected method

Returns a unique 8 character invitation code.

protected getInvitationCode ( )

save() public method

public save ( array $FormPostValues, array \| boolean $UserModel, array $Options = [] ) : boolean
$FormPostValues	array
$UserModel	array \| boolean
$Options	array
return	boolean

send() public method

public send ( $InvitationID )
$InvitationID