PHP Class Airship\Cabin\Bridge\Blueprint\Announcements

Inheritance: extends BlueprintGear
Afficher le fichier Open project: paragonie/airship

Méthodes publiques

Méthode 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 méthode

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

dismissForUser() public méthode

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

getAnnouncementByUniqueID() public méthode

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

getForUser() public méthode

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