Trait luya\web\jsonld\EventTrait

Implemented byluya\web\jsonld\Event
Available since version1.0.0

JsonLd - Event trait

See also http://schema.org/Event.

Public Methods

Hide inherited methods

Method Description Defined By
getAbout() luya\web\jsonld\EventTrait
getActor() luya\web\jsonld\EventTrait
getAttendee() luya\web\jsonld\EventTrait
getComposer() luya\web\jsonld\EventTrait
getContributor() luya\web\jsonld\EventTrait
getDirector() luya\web\jsonld\EventTrait
getDoorTime() luya\web\jsonld\EventTrait
getDuration() luya\web\jsonld\EventTrait
getEndDate() luya\web\jsonld\EventTrait
getFunder() luya\web\jsonld\EventTrait
getInLanguage() luya\web\jsonld\EventTrait
getLocation() luya\web\jsonld\EventTrait
getMaximumAttendeeCapacity() luya\web\jsonld\EventTrait
getOrganizer() luya\web\jsonld\EventTrait
getPerformer() luya\web\jsonld\EventTrait
getPreviousStartDate() luya\web\jsonld\EventTrait
getRecordedIn() luya\web\jsonld\EventTrait
getRemainingAttendeeCapacity() luya\web\jsonld\EventTrait
getSponsor() luya\web\jsonld\EventTrait
getStartDate() luya\web\jsonld\EventTrait
getSubEvent() luya\web\jsonld\EventTrait
getSuperEvent() luya\web\jsonld\EventTrait
getTranslator() luya\web\jsonld\EventTrait
getTypicalAgeRange() luya\web\jsonld\EventTrait
getWorkFeatured() luya\web\jsonld\EventTrait
getWorkPerformed() luya\web\jsonld\EventTrait
isAccessibleForFree() luya\web\jsonld\EventTrait
setAbout() The subject matter of the content. luya\web\jsonld\EventTrait
setActor() An actor, e.g. in tv, radio, movie, video games etc., or in an event. luya\web\jsonld\EventTrait
setAttendee() A person or organization attending the event. Supersedes attendees. luya\web\jsonld\EventTrait
setComposer() The person or organization who wrote a composition, or who is the composer of a work performed at some event. luya\web\jsonld\EventTrait
setContributor() A secondary contributor to the CreativeWork or Event. luya\web\jsonld\EventTrait
setDirector() A director of e.g. tv, radio, movie, video gaming etc. content, or of an event. luya\web\jsonld\EventTrait
setDoorTime() The time admission will commence. luya\web\jsonld\EventTrait
setDuration() The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format. luya\web\jsonld\EventTrait
setEndDate() The end date and time of the item (in ISO 8601 date format). luya\web\jsonld\EventTrait
setFunder() A person or organization that supports (sponsors) something through some kind of financial contribution. luya\web\jsonld\EventTrait
setInLanguage() The language of the content or performance or used in an action. luya\web\jsonld\EventTrait
setIsAccessibleForFree() A flag to signal that the item, event, or place is accessible for free. Supersedes free. luya\web\jsonld\EventTrait
setLocation() The location of for example where the event is happening, an organization is located, or where an action takes place. luya\web\jsonld\EventTrait
setMaximumAttendeeCapacity() The total number of individuals that may attend an event or venue. luya\web\jsonld\EventTrait
setOrganizer() An organizer of an Event. luya\web\jsonld\EventTrait
setPerformer() A performer at the event—for example, a presenter, musician, musical group or actor. luya\web\jsonld\EventTrait
setPreviousStartDate() Used in conjunction with eventStatus for rescheduled or cancelled events. luya\web\jsonld\EventTrait
setRecordedIn() The CreativeWork that captured all or part of this Event. luya\web\jsonld\EventTrait
setRemainingAttendeeCapacity() The number of attendee places for an event that remain unallocated. luya\web\jsonld\EventTrait
setSponsor() A person or organization that supports a thing through a pledge, promise, or financial contribution. luya\web\jsonld\EventTrait
setStartDate() The start date and time of the item (in ISO 8601 date format). luya\web\jsonld\EventTrait
setSubEvent() An Event that is part of this event. luya\web\jsonld\EventTrait
setSuperEvent() An event that this event is a part of. luya\web\jsonld\EventTrait
setTranslator() Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event. luya\web\jsonld\EventTrait
setTypicalAgeRange() The typical expected age range, e.g. '7-9', '11-'. luya\web\jsonld\EventTrait
setWorkFeatured() A work featured in some event, e.g. exhibited in an ExhibitionEvent. luya\web\jsonld\EventTrait
setWorkPerformed() A work performed in some event, for example a play performed in a TheaterEvent. luya\web\jsonld\EventTrait

Method Details

Hide inherited methods

getAbout() public method

public static getAbout ( )

                public function getAbout()
{
    return $this->_about;
}

            
getActor() public method

public luya\web\jsonld\Person getActor ( )

                public function getActor()
{
    return $this->_actor;
}

            
getAttendee() public method

public luya\web\jsonld\Organization|luya\web\jsonld\Person getAttendee ( )

                public function getAttendee()
{
    return $this->_attendee;
}

            
getComposer() public method

public luya\web\jsonld\Organization|luya\web\jsonld\Person getComposer ( )

                public function getComposer()
{
    return $this->_composer;
}

            
getContributor() public method

public luya\web\jsonld\Organization|luya\web\jsonld\Person getContributor ( )

                public function getContributor()
{
    return $this->_contributor;
}

            
getDirector() public method

public luya\web\jsonld\Person getDirector ( )

                public function getDirector()
{
    return $this->_director;
}

            
getDoorTime() public method

public \luya\web\jsonld\DateTime getDoorTime ( )

                public function getDoorTime()
{
    return $this->_doorTime;
}

            
getDuration() public method

public \luya\web\jsonld\Duration getDuration ( )

                public function getDuration()
{
    return $this->_duration;
}

            
getEndDate() public method

public \luya\web\jsonld\Date|\luya\web\jsonld\DateTime getEndDate ( )

                public function getEndDate()
{
    return $this->_endDate;
}

            
getFunder() public method

public luya\web\jsonld\Organization|luya\web\jsonld\Person getFunder ( )

                public function getFunder()
{
    return $this->_funder;
}

            
getInLanguage() public method

public \luya\web\jsonld\Language|\luya\web\jsonld\Text getInLanguage ( )

                public function getInLanguage()
{
    return $this->_inLanguage;
}

            
getLocation() public method

public luya\web\jsonld\Place|luya\web\jsonld\PostalAddress|string getLocation ( )

                public function getLocation()
{
    return $this->_location;
}

            
getMaximumAttendeeCapacity() public method

public integer getMaximumAttendeeCapacity ( )

                public function getMaximumAttendeeCapacity()
{
    return $this->_maximumAttendeeCapacity;
}

            
getOrganizer() public method

public luya\web\jsonld\Organization|luya\web\jsonld\Person getOrganizer ( )

                public function getOrganizer()
{
    return $this->_organizer;
}

            
getPerformer() public method

public luya\web\jsonld\Organization|luya\web\jsonld\Person getPerformer ( )

                public function getPerformer()
{
    return $this->_performer;
}

            
getPreviousStartDate() public method

public string getPreviousStartDate ( )

                public function getPreviousStartDate()
{
    return $this->_previousStartDate;
}

            
getRecordedIn() public method

public luya\web\jsonld\CreativeWork getRecordedIn ( )

                public function getRecordedIn()
{
    return $this->_recordedIn;
}

            
getRemainingAttendeeCapacity() public method

public integer getRemainingAttendeeCapacity ( )

                public function getRemainingAttendeeCapacity()
{
    return $this->_remainingAttendeeCapacity;
}

            
getSponsor() public method

public luya\web\jsonld\Organization|luya\web\jsonld\Person getSponsor ( )

                public function getSponsor()
{
    return $this->_sponsor;
}

            
getStartDate() public method

public \luya\web\jsonld\Date|\luya\web\jsonld\DateTime getStartDate ( )

                public function getStartDate()
{
    return $this->_startDate;
}

            
getSubEvent() public method

public luya\web\jsonld\Event getSubEvent ( )

                public function getSubEvent()
{
    return $this->_subEvent;
}

            
getSuperEvent() public method

public luya\web\jsonld\Event getSuperEvent ( )

                public function getSuperEvent()
{
    return $this->_superEvent;
}

            
getTranslator() public method

public luya\web\jsonld\Organization|luya\web\jsonld\Person getTranslator ( )

                public function getTranslator()
{
    return $this->_translator;
}

            
getTypicalAgeRange() public method

public string getTypicalAgeRange ( )

                public function getTypicalAgeRange()
{
    return $this->_typicalAgeRange;
}

            
getWorkFeatured() public method

public luya\web\jsonld\CreativeWork getWorkFeatured ( )

                public function getWorkFeatured()
{
    return $this->_workFeatured;
}

            
getWorkPerformed() public method

public luya\web\jsonld\CreativeWork getWorkPerformed ( )

                public function getWorkPerformed()
{
    return $this->_workPerformed;
}

            
isAccessibleForFree() public method

public boolean isAccessibleForFree ( )

                public function isAccessibleForFree()
{
    return $this->_isAccessibleForFree;
}

            
setAbout() public method

The subject matter of the content.

Inverse property: subjectOf.

public static setAbout ( luya\web\jsonld\Thing $about )
$about luya\web\jsonld\Thing

                public function setAbout(Thing $about)
{
    $this->_about = $about;
    return $this;
}

            
setActor() public method

An actor, e.g. in tv, radio, movie, video games etc., or in an event.

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

public static setActor ( luya\web\jsonld\Person $actor )
$actor luya\web\jsonld\Person

                public function setActor(Person $actor)
{
    $this->_actor = $actor;
    return $this;
}

            
setAttendee() public method

A person or organization attending the event. Supersedes attendees.

public static setAttendee ( $attendee )
$attendee luya\web\jsonld\Organization|luya\web\jsonld\Person

                public function setAttendee($attendee)
{
    ObjectHelper::isInstanceOf($attendee, [Organization::class, PersonInterface::class]);
    
    $this->_attendee = $attendee;
    return $this;
}

            
setComposer() public method

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

public static setComposer ( $composer )
$composer luya\web\jsonld\Organization|luya\web\jsonld\Person

                public function setComposer($composer)
{
    ObjectHelper::isInstanceOf($author, [Organization::class, PersonInterface::class]);
    
    $this->_composer = $composer;
    return $this;
}

            
setContributor() public method

A secondary contributor to the CreativeWork or Event.

public static setContributor ( $contributor )
$contributor luya\web\jsonld\Organization|luya\web\jsonld\Person

                public function setContributor($contributor)
{
    ObjectHelper::isInstanceOf($contributor, [Organization::class, PersonInterface::class]);
    
    $this->_contributor = $contributor;
    return $this;
}

            
setDirector() public method

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

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

public static setDirector ( luya\web\jsonld\Person $director )
$director luya\web\jsonld\Person

                public function setDirector(Person $director)
{
    $this->_director = $director;
    return $this;
}

            
setDoorTime() public method

The time admission will commence.

public static setDoorTime ( luya\web\jsonld\DateTimeValue $doorTime )
$doorTime \luya\web\jsonld\DateTime

                public function setDoorTime(DateTimeValue $doorTime)
{
    $this->_doorTime = $doorTime->getValue();
    return $this;
}

            
setDuration() public method

The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.

public static setDuration ( luya\web\jsonld\DurationValue $duration )
$duration \luya\web\jsonld\Duration

                public function setDuration(DurationValue $duration)
{
    $this->_duration = $duration->getValue();
    return $this;
}

            
setEndDate() public method

The end date and time of the item (in ISO 8601 date format).

public static setEndDate ( luya\web\jsonld\DateTimeValue $endDate )
$endDate \luya\web\jsonld\Date|\luya\web\jsonld\DateTime

                public function setEndDate(DateTimeValue $endDate)
{
    $this->_endDate = $endDate->getValue();
    return $this;
}

            
setFunder() public method

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

public static setFunder ( $funder )
$funder luya\web\jsonld\Organization|luya\web\jsonld\Person

                public function setFunder($funder)
{
    ObjectHelper::isInstanceOf($funder, [Organization::class, PersonInterface::class]);
    
    $this->_funder = $funder;
    return $this;
}

            
setInLanguage() public method

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

Please use one of the language codes from the IETF BCP 47 standard. See also availableLanguage. Supersedes language.

public static setInLanguage ( luya\web\jsonld\LanguageValue $inLanguage )
$inLanguage \luya\web\jsonld\Language|\luya\web\jsonld\Text

                public function setInLanguage(LanguageValue $inLanguage)
{
    $this->_inLanguage = $inLanguage->getValue();
    return $this;
}

            
setIsAccessibleForFree() public method

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

public static setIsAccessibleForFree ( $isAccessibleForFree )
$isAccessibleForFree boolean

                public function setIsAccessibleForFree($isAccessibleForFree)
{
    $this->_isAccessibleForFree = $isAccessibleForFree;
    return $this;
}

            
setLocation() public method

The location of for example where the event is happening, an organization is located, or where an action takes place.

public static setLocation ( $location )
$location luya\web\jsonld\Place|luya\web\jsonld\PostalAddress|string

                public function setLocation($location)
{
    $this->_location = $location;
    return $this;
}

            
setMaximumAttendeeCapacity() public method

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

public void setMaximumAttendeeCapacity ( $maximumAttendeeCapacity )
$maximumAttendeeCapacity integer

                public function setMaximumAttendeeCapacity($maximumAttendeeCapacity)
{
    $this->_maximumAttendeeCapacity = $maximumAttendeeCapacity;
}

            
setOrganizer() public method

An organizer of an Event.

public static setOrganizer ( $organizer )
$organizer luya\web\jsonld\Organization|luya\web\jsonld\Person

                public function setOrganizer($organizer)
{
    ObjectHelper::isInstanceOf($organizer, [Organization::class, PersonInterface::class]);
    
    $this->_organizer = $organizer;
    return $this;
}

            
setPerformer() public method

A performer at the event—for example, a presenter, musician, musical group or actor.

Supersedes performers.

public static setPerformer ( $performer )
$performer luya\web\jsonld\Organization|luya\web\jsonld\Person

                public function setPerformer($performer)
{
    ObjectHelper::isInstanceOf($performer, [Organization::class, PersonInterface::class]);
    
    $this->_performer = $performer;
    return $this;
}

            
setPreviousStartDate() public method

Used in conjunction with eventStatus for rescheduled or cancelled events.

This property contains the previously scheduled start date. For rescheduled events, the startDate property should be used for the newly scheduled start date. In the (rare) case of an event that has been postponed and rescheduled multiple times, this field may be repeated.

public static setPreviousStartDate ( luya\web\jsonld\DateValue $previousStartDate )
$previousStartDate luya\web\jsonld\DateValue

                public function setPreviousStartDate(DateValue $previousStartDate)
{
    $this->_previousStartDate = $previousStartDate->getValue();
    return $this;
}

            
setRecordedIn() public method

The CreativeWork that captured all or part of this Event.

Inverse property: recordedAt

public static setRecordedIn ( luya\web\jsonld\CreativeWork $recordedIn )
$recordedIn luya\web\jsonld\CreativeWork

                public function setRecordedIn(CreativeWork $recordedIn)
{
    $this->_recordedIn = $recordedIn;
    return $this;
}

            
setRemainingAttendeeCapacity() public method

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

public static setRemainingAttendeeCapacity ( $remainingAttendeeCapacity )
$remainingAttendeeCapacity integer

                public function setRemainingAttendeeCapacity($remainingAttendeeCapacity)
{
    $this->_remainingAttendeeCapacity = $remainingAttendeeCapacity;
    return $this;
}

            
setSponsor() public method

A person or organization that supports a thing through a pledge, promise, or financial contribution.

e.g. a sponsor of a Medical Study or a corporate sponsor of an event.

public static setSponsor ( $sponsor )
$sponsor luya\web\jsonld\Organization|luya\web\jsonld\Person

                public function setSponsor($sponsor)
{
    ObjectHelper::isInstanceOf($sponsor, [Organization::class, PersonInterface::class]);
    
    $this->_sponsor = $sponsor;
    return $this;
}

            
setStartDate() public method

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

public static setStartDate ( luya\web\jsonld\DateTimeValue $startDate )
$startDate luya\web\jsonld\DateTimeValue

                public function setStartDate(DateTimeValue $startDate)
{
    $this->_startDate = $startDate->getValue();
    return $this;
}

            
setSubEvent() public method

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. Inverse property: superEvent.

public void setSubEvent ( luya\web\jsonld\Event $subEvent )
$subEvent luya\web\jsonld\Event

                public function setSubEvent(Event $subEvent)
{
    $this->_subEvent = $subEvent;
}

            
setSuperEvent() public method

An event that this event is a part of.

For example, a collection of individual music performances might each have a music festival as their superEvent. Inverse property: subEvent.

public static setSuperEvent ( luya\web\jsonld\Event $superEvent )
$superEvent luya\web\jsonld\Event

                public function setSuperEvent(Event $superEvent)
{
    $this->_superEvent = $superEvent;
    return $this;
}

            
setTranslator() public method

Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.

public static setTranslator ( $translator )
$translator luya\web\jsonld\Organization|luya\web\jsonld\Person

                public function setTranslator($translator)
{
    ObjectHelper::isInstanceOf($translator, [Organization::class, PersonInterface::class]);
    
    $this->_translator = $translator;
    return $this;
}

            
setTypicalAgeRange() public method

The typical expected age range, e.g. '7-9', '11-'.

public static setTypicalAgeRange ( $typicalAgeRange )
$typicalAgeRange string

                public function setTypicalAgeRange($typicalAgeRange)
{
    $this->_typicalAgeRange = $typicalAgeRange;
    return $this;
}

            
setWorkFeatured() public method

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

Specific subproperties are available for workPerformed (e.g. a play), or a workPresented (a Movie at a ScreeningEvent).

public static setWorkFeatured ( luya\web\jsonld\CreativeWork $workFeatured )
$workFeatured luya\web\jsonld\CreativeWork

                public function setWorkFeatured(CreativeWork $workFeatured)
{
    $this->_workFeatured = $workFeatured;
    return $this;
}

            
setWorkPerformed() public method

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

public static setWorkPerformed ( luya\web\jsonld\CreativeWork $workPerformed )
$workPerformed luya\web\jsonld\CreativeWork

                public function setWorkPerformed(CreativeWork $workPerformed)
{
    $this->_workPerformed = $workPerformed;
    return $this;
}