AnnouncementRepositoryInterface
in
Describes behavior of the announcement repository
Table of Contents
Methods
- add() : AnnouncementId
- Adds an announcement
- delete() : int
- Deletes an announcement with provided ID.
- deleteRejectedOlderThan() : int
- Deletes rejected announcements older than the specified date.
- findAll() : array<string|int, Announcement>
- Returns all announcements
- findById() : Announcement|null
- Returns an announcement with provided id (if found)
- findByTitle() : array<string|int, Announcement>
- Returns all announcement with similar title
- findPending() : array<string|int, Announcement>
- Returns all announcements that have pending status
- findValid() : array<string|int, Announcement>
- Returns all announcements that are valid on condition that <li> announcement valid date is valid today</li> <li> announcement is approved </li>
- update() : int
- Updates an announcement.
Methods
add()
Adds an announcement
public
add(Announcement $announcement) : AnnouncementId
Parameters
- $announcement : Announcement
Tags
Return values
AnnouncementIddelete()
Deletes an announcement with provided ID.
public
delete(AnnouncementId $id) : int
Parameters
- $id : AnnouncementId
Tags
Return values
int —Number of deleted rows
deleteRejectedOlderThan()
Deletes rejected announcements older than the specified date.
public
deleteRejectedOlderThan(DateTimeImmutable $date) : int
Parameters
- $date : DateTimeImmutable
Tags
Return values
int —Number of deleted rows
findAll()
Returns all announcements
public
findAll() : array<string|int, Announcement>
Tags
Return values
array<string|int, Announcement>findById()
Returns an announcement with provided id (if found)
public
findById(AnnouncementId $id) : Announcement|null
Parameters
- $id : AnnouncementId
Tags
Return values
Announcement|nullfindByTitle()
Returns all announcement with similar title
public
findByTitle(string $title) : array<string|int, Announcement>
Parameters
- $title : string
Tags
Return values
array<string|int, Announcement>findPending()
Returns all announcements that have pending status
public
findPending() : array<string|int, Announcement>
Tags
Return values
array<string|int, Announcement>findValid()
Returns all announcements that are valid on condition that <li> announcement valid date is valid today</li> <li> announcement is approved </li>
public
findValid() : array<string|int, Announcement>
Tags
Return values
array<string|int, Announcement>update()
Updates an announcement.
public
update(Announcement $announcement) : int
Parameters
- $announcement : Announcement
Tags
Return values
int —number of affected rows