Subscribe
in package
AbstractYes
Base class for the content subscription handlers
Table of Contents
Methods
- getList() : array<string|int, mixed>
- Return a list of records for the provided settings
- getName() : string
- Return a (string) name for this subscription.
Methods
getList()
Return a list of records for the provided settings
public
abstract getList(array<string|int, mixed> $handler_settings, int $since) : array<string|int, mixed>
Parameters
- $handler_settings : array<string|int, mixed>
-
The settings provided when the user subscribed
- $since : int
-
The start timestamp for returned events
Return values
array<string|int, mixed> —An array-of-arrays result set
Each item in the list should be an array, with the following keys: name The name of the item text A short, plain-text description of the item url The URL to provide to the user. Can be absolute (http://...) or relative (/...) ts The event timestamp (unix format)
getName()
Return a (string) name for this subscription.
public
abstract getName(array<string|int, mixed> $handler_settings) : string
You can use the settings to tweak the title (e.g. the category of articles).
Parameters
- $handler_settings : array<string|int, mixed>
-
The settings provided when the user subscribed
Return values
string —An title shown to end users