PHP Class Airship\Cabin\Bridge\Blueprint\Announcements

Inheritance: extends BlueprintGear
Show file Open project: paragonie/airship

Public Methods

Method Description
createAnnouncement ( array $post ) : boolean Post a new announcement
dismissForUser ( integer $userID, string $announceUnique ) : boolean Dismisses an announcement for a particular user.
getAnnouncementByUniqueID ( string $uniqueID ) : array Get a particular announcement, given its unique ID.
getForUser ( integer $userID ) : array Get all of the announcements the user has not yet dismissed.

Method Details

createAnnouncement() public method

Post a new announcement
public createAnnouncement ( array $post ) : boolean
$post array POST data from the Landing
return boolean

dismissForUser() public method

Dismisses an announcement for a particular user.
public dismissForUser ( integer $userID, string $announceUnique ) : boolean
$userID integer
$announceUnique string
return boolean

getAnnouncementByUniqueID() public method

Get a particular announcement, given its unique ID.
public getAnnouncementByUniqueID ( string $uniqueID ) : array
$uniqueID string
return array

getForUser() public method

Get all of the announcements the user has not yet dismissed.
public getForUser ( integer $userID ) : array
$userID integer
return array