DeleteExpiredInterface
in
Interface for exposing the "deleteExpired" method required by command line cleanup tools.
Tags
Table of Contents
- deleteExpired() : int
- Delete expired records. Allows setting a limit so that rows can be deleted in small batches.
Methods
deleteExpired()
Delete expired records. Allows setting a limit so that rows can be deleted in small batches.
public
deleteExpired(DateTime $dateLimit[, int|null $limit = null ]) : int
Parameters
- $dateLimit : DateTime
-
Date threshold of an "expired" record.
- $limit : int|null = null
-
Maximum number of rows to delete or null for no limit.
Return values
int —Number of rows deleted