Oihana PHP System

Event extends Thing

An event happening at a certain time and location, such as a concert, lecture, or festival. Repeated events may be structured as separate Event objects.

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.
$about  : string|object|null
The subject matter of the content.
$active  : bool|null
The active flag.
$actor  : array<string|int, mixed>|Person|PerformingGroup|null
An actor (individual or a group), e.g. in TV, radio, movie, video games etc., or in an event.
$additionalType  : array<string|int, mixed>|string|null|object
An additionalType for the item.
$aggregateRating  : array<string|int, mixed>|AggregateRating|null
The overall rating, based on a collection of reviews or ratings, of the item.
$alternateName  : string|object|null
An alias for the item.
$attendee  : Person|Organization|array<string|int, mixed>|null
A person or organization attending the event.
$audience  : array<string|int, mixed>|Audience|null
An intended audience, i.e. a group for whom something was created. Supersedes serviceAudience.
$composer  : Person|Organization|string|null
The person or organization who wrote a composition, or who is the composer of a work performed at some event.
$contributor  : Person|Organization|string|null
A secondary contributor to the CreativeWork or Event.
$created  : null|string|DateTime
Date of creation of the resource.
$description  : string|null
A short description of the item.
$director  : Person|array<string|int, mixed>|null
A director of e.g. TV, radio, movie, video gaming etc. content, or of an event.
$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.
$doorTime  : string|DateTime|null
The time admission will commence.
$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).
$eventAttendanceMode  : EventAttendanceModeEnumeration|DefinedTerm|string|null
The eventAttendanceMode of an event indicates whether it occurs online, offline, or a mix.
$eventSchedule  : array<string|int, mixed>|Schedule|null
Associates an Event with a Schedule.
$eventStatus  : string|DefinedTerm|EventStatusType|null
An eventStatus of an event represents its status; particularly useful when an event is cancelled or rescheduled.
$funder  : array<string|int, mixed>|Organization|Person|null
A person or organization that supports (sponsors) something through some kind of financial contribution.
$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.
$inLanguage  : array<string|int, mixed>|string|Language|null
The language of the content or performance or used in an action.
$isAccessibleForFree  : bool|null
A flag to signal that the item, event, or place is accessible for free.
$isPartOf  : string|Thing|array<string|int, mixed>|null
Indicates an item that this item is part of.
$keywords  : string|DefinedTerm|array<string|int, mixed>|null
Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
$license  : string|object|null
A legal document giving official permission to do something with the resource.
$location  : PostalAddress|Place|VirtualLocation|string|null
The location of the event, organization or action.
$maximumAttendeeCapacity  : int|null
The total number of individuals that may attend an event or venue.
$maximumPhysicalAttendeeCapacity  : int|null
The maximum physical attendee capacity of an Event whose eventAttendanceMode is OfflineEventAttendanceMode (or the offline aspects, in the case of a MixedEventAttendanceMode).
$maximumVirtualAttendeeCapacity  : int|null
The maximum virtual attendee capacity of an Event whose eventAttendanceMode is OnlineEventAttendanceMode (or the offline aspects, in the case of a MixedEventAttendanceMode).
$modified  : null|string|DateTime
Date on which the resource was changed.
$name  : int|string|null
The name of the item.
$offers  : null|array<string|int, mixed>|Offer|Demand
A collection of Offer items to provide this item - for example, an offer to sell a product, rent the DVD of a movie, or give away tickets to an event.
$organizer  : array<string|int, mixed>|null|Person|Organization
An organizer of an Event.
$photos  : array<string|int, mixed>|null
Photographs of this place (legacy spelling; see singular form, photo).
$publisher  : string|array<string|int, mixed>|Person|Organization|null
The publisher of the resource.
$remainingAttendeeCapacity  : int|null
The number of attendee places for an event that remain unallocated.
$remarks  : string|object|null
The remarks about the resource.
$review  : array<string|int, mixed>|Review|null
A review of the item.
$startDate  : null|string|int|DateTime
The start date and time of the event or item (in ISO 8601 date format).
$subEvent  : Event|array<string|int, mixed>|null
An Event that is part of this event. For example, a conference event includes many presentations, each of which is a subEvent of the conference. Supersedes subEvents.
$url  : int|string|null
URL of the item.
$workFeatured  : string|array<string|int, mixed>|CreativeWork|null
A work featured in some event, e.g. exhibited in an ExhibitionEvent.
$workPerformed  : array<string|int, mixed>|CreativeWork|null
A work performed in some event, for example a play performed in a TheaterEvent.

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

$about

The subject matter of the content.

public string|object|null $about

$active

The active flag.

public bool|null $active

$actor

An actor (individual or a group), e.g. in TV, radio, movie, video games etc., or in an event.

public array<string|int, mixed>|Person|PerformingGroup|null $actor

Actors can be associated with individual items or with a series, episode, clip.

$additionalType

An additionalType for the item.

public array<string|int, mixed>|string|null|object $additionalType

$aggregateRating

The overall rating, based on a collection of reviews or ratings, of the item.

public array<string|int, mixed>|AggregateRating|null $aggregateRating

$alternateName

An alias for the item.

public string|object|null $alternateName

$attendee

A person or organization attending the event.

public Person|Organization|array<string|int, mixed>|null $attendee

$audience

An intended audience, i.e. a group for whom something was created. Supersedes serviceAudience.

public array<string|int, mixed>|Audience|null $audience

$composer

The person or organization who wrote a composition, or who is the composer of a work performed at some event.

public Person|Organization|string|null $composer

$contributor

A secondary contributor to the CreativeWork or Event.

public Person|Organization|string|null $contributor

$created

Date of creation of the resource.

public null|string|DateTime $created

$description

A short description of the item.

public string|null $description

$director

A director of e.g. TV, radio, movie, video gaming etc. content, or of an event.

public Person|array<string|int, mixed>|null $director

Directors can be associated with individual items or with a series, episode, clip.

$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

$doorTime

The time admission will commence.

public string|DateTime|null $doorTime

$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

$eventAttendanceMode

The eventAttendanceMode of an event indicates whether it occurs online, offline, or a mix.

public EventAttendanceModeEnumeration|DefinedTerm|string|null $eventAttendanceMode

$eventSchedule

Associates an Event with a Schedule.

public array<string|int, mixed>|Schedule|null $eventSchedule

There are circumstances where it is preferable to share a schedule for a series of repeating events rather than data on the individual events themselves. For example, a website or application might prefer to publish a schedule for a weekly gym class rather than provide data on every event. A schedule could be processed by applications to add forthcoming events to a calendar. An Event that is associated with a Schedule using this property should not have startDate or endDate properties. These are instead defined within the associated Schedule, this avoids any ambiguity for clients using the data. The property might have repeated values to specify different schedules, e.g. for different months or seasons.

$eventStatus

An eventStatus of an event represents its status; particularly useful when an event is cancelled or rescheduled.

public string|DefinedTerm|EventStatusType|null $eventStatus

$funder

A person or organization that supports (sponsors) something through some kind of financial contribution.

public array<string|int, mixed>|Organization|Person|null $funder

$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

$inLanguage

The language of the content or performance or used in an action.

public array<string|int, mixed>|string|Language|null $inLanguage

Please use one of the language codes from the IETF BCP 47 standard.

Tags
see
IETF

BCP 47 : http://tools.ietf.org/html/bcp47

$isAccessibleForFree

A flag to signal that the item, event, or place is accessible for free.

public bool|null $isAccessibleForFree

$isPartOf

Indicates an item that this item is part of.

public string|Thing|array<string|int, mixed>|null $isPartOf

$keywords

Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.

public string|DefinedTerm|array<string|int, mixed>|null $keywords

$license

A legal document giving official permission to do something with the resource.

public string|object|null $license

$maximumAttendeeCapacity

The total number of individuals that may attend an event or venue.

public int|null $maximumAttendeeCapacity

Supersedes capacity. Supersedes $numAttendee.

$maximumPhysicalAttendeeCapacity

The maximum physical attendee capacity of an Event whose eventAttendanceMode is OfflineEventAttendanceMode (or the offline aspects, in the case of a MixedEventAttendanceMode).

public int|null $maximumPhysicalAttendeeCapacity

$maximumVirtualAttendeeCapacity

The maximum virtual attendee capacity of an Event whose eventAttendanceMode is OnlineEventAttendanceMode (or the offline aspects, in the case of a MixedEventAttendanceMode).

public int|null $maximumVirtualAttendeeCapacity

$modified

Date on which the resource was changed.

public null|string|DateTime $modified

$name

The name of the item.

public int|string|null $name

$offers

A collection of Offer items to provide this item - for example, an offer to sell a product, rent the DVD of a movie, or give away tickets to an event.

public null|array<string|int, mixed>|Offer|Demand $offers

$photos

Photographs of this place (legacy spelling; see singular form, photo).

public array<string|int, mixed>|null $photos

$remainingAttendeeCapacity

The number of attendee places for an event that remain unallocated.

public int|null $remainingAttendeeCapacity

$remarks

The remarks about the resource.

public string|object|null $remarks

$review

A review of the item.

public array<string|int, mixed>|Review|null $review

$startDate

The start date and time of the event or item (in ISO 8601 date format).

public null|string|int|DateTime $startDate

$subEvent

An Event that is part of this event. For example, a conference event includes many presentations, each of which is a subEvent of the conference. Supersedes subEvents.

public Event|array<string|int, mixed>|null $subEvent

$url

URL of the item.

public int|string|null $url

$workFeatured

A work featured in some event, e.g. exhibited in an ExhibitionEvent.

public string|array<string|int, mixed>|CreativeWork|null $workFeatured

$workPerformed

A work performed in some event, for example a play performed in a TheaterEvent.

public array<string|int, mixed>|CreativeWork|null $workPerformed

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
example
use org\schema\Person;
use org\schema\constants\Prop;

$person = new Person
([
    Prop::NAME => 'Jane Doe',
    Prop::URL  => 'https://example.com/janedoe'
]);

echo $person->name; // Outputs: Jane Doe

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
throws
ReflectionException

If reflection fails when accessing properties.

example
use org\schema\Person;
use org\schema\constants\Prop;

$person = new Person([
    Prop::NAME => 'John Smith',
    Prop::ID   => 'jsmith-001'
]);

echo json_encode($person, JSON_PRETTY_PRINT);

Output:

{
  "@type": "Person",
  "@context": "https://schema.org",
  "id": "jsmith-001",
  "name": "John Smith"
}
Return values
array<string|int, mixed>

A JSON-LD array representation of the object.


        
On this page

Search results