EventAdjustment
in package
Used to apply adjustments to properties of EventOccurrence objects.
Table of Contents
Properties
- $affects_future : bool
- $duration : TimeInterval
- $id : string
- $location : string
- $offset : TimeInterval
- $title : string
Methods
- __construct() : mixed
- Constructor.
- createBatch() : array<string|int, mixed>
- Creates a batch of EventAdjustment instances from JSON data.
Properties
$affects_future
public
bool
$affects_future
= false
Determines whether future event occurrences are affected or not.
$duration
public
TimeInterval
$duration
A TimeInterval object representing the duration of the affected occurrences of the event.
$id
public
string
$id
The ID of the first affected occurrence of the event.
$location
public
string
$location
Location for the affected occurrences of this event.
$offset
public
TimeInterval
$offset
A TimeInterval object representing how much to the adjust the start of the affected occurrences compared to their original start date.
$title
public
string
$title
Title for the affected occurrences of the event.
Methods
__construct()
Constructor.
public
__construct(int $id[, bool $affects_future = false ][, array<string|int, mixed>|null $offset = null ][, array<string|int, mixed>|null $duration = null ][, string|null $location = null ][, string|null $title = null ]) : mixed
Parameters
- $id : int
-
The ID string of the first affected event occurrence.
- $affects_future : bool = false
-
Whether future occurrences are also affected. Default: false.
- $offset : array<string|int, mixed>|null = null
-
Array representation of SMF\TimeInterval data.
- $duration : array<string|int, mixed>|null = null
-
Array representation of SMF\TimeInterval data.
- $location : string|null = null
-
Location string.
- $title : string|null = null
-
Title string.
createBatch()
Creates a batch of EventAdjustment instances from JSON data.
public
static createBatch(string $json) : array<string|int, mixed>
Parameters
- $json : string
-
JSON string containing a batch of adjustment data.
Return values
array<string|int, mixed> —Instances of this class.