Schedule extends Intangible
A schedule defines a repeating time period used to describe a regularly occurring Event.
At a minimum a schedule will specify repeatFrequency which describes the interval between occurrences of the event. Additional information can be provided to specify the schedule more precisely. This includes identifying the day(s) of the week or month when the recurring event will take place, in addition to its start and end time. Schedules may also have start and end dates to indicate when they are active, e.g. to define a limited calendar of events.
Tags
Table of Contents
Constants
- CONTEXT = 'https://schema.org'
- JSON-LD @context declaration for Schema.org.
Properties
- $_from : string|null
- The metadata to indicates the edge 'from' identifier.
- $_id : null|string
- The metadata identifier of the item.
- $_key : null|string
- The metadata unique key identifier of the thing.
- $_rev : null|string
- The metadata revision value of the thing.
- $_to : string|null
- The metadata to indicates the edge 'to' identifier.
- $active : bool|null
- The active flag.
- $additionalType : array<string|int, mixed>|string|null|object
- An additionalType for the item.
- $alternateName : string|object|null
- An alias for the item.
- $byDay : DayOfWeek|DefinedTerm|string|array<string|int, mixed>|null
- Defines the day(s) of the week on which a recurring Event takes place.
- $byMonth : int|array<string|int, mixed>|null
- Defines the month(s) of the year on which a recurring Event takes place.
- $byMonthDay : int|array<string|int, mixed>|null
- Defines the day(s) of the month on which a recurring Event takes place.
- $byMonthWeek : int|array<string|int, mixed>|null
- Defines the week(s) of the month on which a recurring Event takes place.
- $created : null|string|DateTime
- Date of creation of the resource.
- $description : string|null
- A short description of the item.
- $disambiguatingDescription : string|null
- A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
- $duration : null|int|float|string|Duration|QuantitativeValue
- The duration of the item (movie, audio recording, event, etc.) in ISO 8601 duration format.
- $endDate : null|string|int|DateTime
- The end date and time of the event or item (in ISO 8601 date format).
- $endTime : null|string|int|DateTime
- The endTime of something.
- $exceptDate : string|array<string|int, mixed>|int|DateTime|null
- Defines a Date or DateTime during which a scheduled Event will not take place. The property allows exceptions to a Schedule to be specified. If an exception is specified as a DateTime then only the event that would have started at that specific date and time should be excluded from the schedule. If an exception is specified as a Date then any event that is scheduled for that 24 hour period should be excluded from the schedule.
- $hasPart : string|Thing|array<string|int, mixed>|null
- Indicates an item that this part of this item.
- $id : null|int|string
- The unique identifier of the item.
- $identifier : string|null
- The identifier of the item.
- $image : string|object|null
- The image reference of this resource.
- $isPartOf : string|Thing|array<string|int, mixed>|null
- Indicates an item that this item is part of.
- $license : string|object|null
- A legal document giving official permission to do something with the resource.
- $modified : null|string|DateTime
- Date on which the resource was changed.
- $name : int|string|null
- The name of the item.
- $publisher : string|array<string|int, mixed>|Person|Organization|null
- The publisher of the resource.
- $repeatCount : int|null
- Defines the number of times a recurring Event will take place.
- $repeatFrequency : Duration|string|int|float|null
- Defines the frequency at which Events will occur according to a schedule Schedule. The intervals between events should be defined as a Duration of time.
- $scheduleTimezone : string|null
- Indicates the timezone for which the time(s) indicated in the Schedule are given. The value provided should be among those listed in the IANA Time Zone Database.
- $startDate : null|string|int|DateTime
- The start date and time of the event or item (in ISO 8601 date format).
- $startTime : null|string|int|DateTime
- The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.
- $url : int|string|null
- URL of the item.
Methods
- __construct() : mixed
- Constructor to hydrate public properties from an array or stdClass.
- jsonSerialize() : array<string|int, mixed>
- Serializes the current object into a JSON-LD array.
Constants
CONTEXT
JSON-LD @context declaration for Schema.org.
public
mixed
CONTEXT
= 'https://schema.org'
Properties
$_from
The metadata to indicates the edge 'from' identifier.
public
string|null
$_from
$_id
The metadata identifier of the item.
public
null|string
$_id
$_key
The metadata unique key identifier of the thing.
public
null|string
$_key
$_rev
The metadata revision value of the thing.
public
null|string
$_rev
$_to
The metadata to indicates the edge 'to' identifier.
public
string|null
$_to
$active
The active flag.
public
bool|null
$active
$additionalType
An additionalType for the item.
public
array<string|int, mixed>|string|null|object
$additionalType
$alternateName
An alias for the item.
public
string|object|null
$alternateName
$byDay
Defines the day(s) of the week on which a recurring Event takes place.
public
DayOfWeek|DefinedTerm|string|array<string|int, mixed>|null
$byDay
May be specified using either DayOfWeek, or alternatively Text conforming to iCal's syntax for byDay recurrence rules.
$byMonth
Defines the month(s) of the year on which a recurring Event takes place.
public
int|array<string|int, mixed>|null
$byMonth
Specified as an Integer between 1-12. January is 1.
$byMonthDay
Defines the day(s) of the month on which a recurring Event takes place.
public
int|array<string|int, mixed>|null
$byMonthDay
Specified as an Integer between 1-31.
$byMonthWeek
Defines the week(s) of the month on which a recurring Event takes place.
public
int|array<string|int, mixed>|null
$byMonthWeek
Specified as an Integer between 1-5. For clarity, byMonthWeek is best used in conjunction with byDay to indicate concepts like the first and third Mondays of a month.
$created
Date of creation of the resource.
public
null|string|DateTime
$created
$description
A short description of the item.
public
string|null
$description
$disambiguatingDescription
A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
public
string|null
$disambiguatingDescription
$duration
The duration of the item (movie, audio recording, event, etc.) in ISO 8601 duration format.
public
null|int|float|string|Duration|QuantitativeValue
$duration
$endDate
The end date and time of the event or item (in ISO 8601 date format).
public
null|string|int|DateTime
$endDate
$endTime
The endTime of something.
public
null|string|int|DateTime
$endTime
For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the end of a clip within a larger file. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
$exceptDate
Defines a Date or DateTime during which a scheduled Event will not take place. The property allows exceptions to a Schedule to be specified. If an exception is specified as a DateTime then only the event that would have started at that specific date and time should be excluded from the schedule. If an exception is specified as a Date then any event that is scheduled for that 24 hour period should be excluded from the schedule.
public
string|array<string|int, mixed>|int|DateTime|null
$exceptDate
This allows a whole day to be excluded from the schedule without having to itemise every scheduled event.
$hasPart
Indicates an item that this part of this item.
public
string|Thing|array<string|int, mixed>|null
$hasPart
$id
The unique identifier of the item.
public
null|int|string
$id
$identifier
The identifier of the item.
public
string|null
$identifier
$image
The image reference of this resource.
public
string|object|null
$image
$isPartOf
Indicates an item that this item is part of.
public
string|Thing|array<string|int, mixed>|null
$isPartOf
$license
A legal document giving official permission to do something with the resource.
public
string|object|null
$license
$modified
Date on which the resource was changed.
public
null|string|DateTime
$modified
$name
The name of the item.
public
int|string|null
$name
$publisher
The publisher of the resource.
public
string|array<string|int, mixed>|Person|Organization|null
$publisher
$repeatCount
Defines the number of times a recurring Event will take place.
public
int|null
$repeatCount
$repeatFrequency
Defines the frequency at which Events will occur according to a schedule Schedule. The intervals between events should be defined as a Duration of time.
public
Duration|string|int|float|null
$repeatFrequency
$scheduleTimezone
Indicates the timezone for which the time(s) indicated in the Schedule are given. The value provided should be among those listed in the IANA Time Zone Database.
public
string|null
$scheduleTimezone
$startDate
The start date and time of the event or item (in ISO 8601 date format).
public
null|string|int|DateTime
$startDate
$startTime
The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.
public
null|string|int|DateTime
$startTime
$url
URL of the item.
public
int|string|null
$url
Methods
__construct()
Constructor to hydrate public properties from an array or stdClass.
public
__construct([array<string|int, mixed>|object|null $init = null ]) : mixed
This allows objects to be quickly populated with associative data without manually setting each property.
Parameters
- $init : array<string|int, mixed>|object|null = null
-
A data array or object used to initialize the instance. Keys must match public property names.
Tags
jsonSerialize()
Serializes the current object into a JSON-LD array.
public
jsonSerialize() : array<string|int, mixed>
This method will include all public properties, the schema.org @context, and the inferred @type based on the class name.
Null values will be automatically removed using compress().
Tags
Return values
array<string|int, mixed> —A JSON-LD array representation of the object.