Class luya\web\jsonld\Event
Inheritance | luya\web\jsonld\Event » luya\web\jsonld\BaseThing » yii\base\BaseObject |
---|---|
Implements | luya\web\jsonld\EventInterface, luya\web\jsonld\ThingInterface, yii\base\Arrayable, yii\base\Configurable |
Uses Traits | luya\web\jsonld\EventTrait, luya\web\jsonld\ThingTrait, yii\base\ArrayableTrait |
Available since version | 1.0.0 |
Source Code | https://github.com/luyadev/luya/blob/master/core/web/jsonld/Event.php |
JsonLd - Event
An event happening at a certain time and location, such as a concert, lecture, or festival. Ticketing information may be added via the offers property. Repeated events may be structured as separate Event objects.
See also http://schema.org/Event.
Public Properties
Public Methods
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | yii\base\BaseObject |
__construct() | Constructor. | yii\base\BaseObject |
__get() | Returns the value of an object property. | yii\base\BaseObject |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
__set() | Sets value of an object property. | yii\base\BaseObject |
__unset() | Sets an object property to null. | yii\base\BaseObject |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\BaseObject |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject |
className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
extraFields() | Returns the list of fields that can be expanded further and returned by toArray(). | yii\base\ArrayableTrait |
fields() | Returns the list of fields that should be returned by default by toArray() when no specific fields are specified. | luya\web\jsonld\BaseThing |
getAbout() | luya\web\jsonld\EventTrait | |
getActor() | luya\web\jsonld\EventTrait | |
getAdditionalType() | luya\web\jsonld\ThingTrait | |
getAlternateName() | luya\web\jsonld\ThingTrait | |
getAttendee() | luya\web\jsonld\EventTrait | |
getComposer() | luya\web\jsonld\EventTrait | |
getContributor() | luya\web\jsonld\EventTrait | |
getDescription() | luya\web\jsonld\ThingTrait | |
getDirector() | luya\web\jsonld\EventTrait | |
getDisambiguatingDescription() | luya\web\jsonld\ThingTrait | |
getDoorTime() | luya\web\jsonld\EventTrait | |
getDuration() | luya\web\jsonld\EventTrait | |
getEndDate() | luya\web\jsonld\EventTrait | |
getFunder() | luya\web\jsonld\EventTrait | |
getIdentifier() | luya\web\jsonld\ThingTrait | |
getImage() | luya\web\jsonld\ThingTrait | |
getInLanguage() | luya\web\jsonld\EventTrait | |
getLocation() | luya\web\jsonld\EventTrait | |
getMainEntityOfPage() | luya\web\jsonld\ThingTrait | |
getMaximumAttendeeCapacity() | luya\web\jsonld\EventTrait | |
getName() | luya\web\jsonld\ThingTrait | |
getOffers() | Get Offer | luya\web\jsonld\ThingTrait |
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 | |
getSameAs() | luya\web\jsonld\ThingTrait | |
getSponsor() | luya\web\jsonld\EventTrait | |
getStartDate() | luya\web\jsonld\EventTrait | |
getSubEvent() | luya\web\jsonld\EventTrait | |
getSubjectOf() | luya\web\jsonld\ThingTrait | |
getSuperEvent() | luya\web\jsonld\EventTrait | |
getTranslator() | luya\web\jsonld\EventTrait | |
getTypicalAgeRange() | luya\web\jsonld\EventTrait | |
getUrl() | luya\web\jsonld\ThingTrait | |
getWorkFeatured() | luya\web\jsonld\EventTrait | |
getWorkPerformed() | luya\web\jsonld\EventTrait | |
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\BaseObject |
hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject |
init() | Initializes the object. | yii\base\BaseObject |
isAccessibleForFree() | luya\web\jsonld\EventTrait | |
resolveGetterMethods() | Find all getter methods. | luya\web\jsonld\BaseThing |
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 |
setAdditionalType() | An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. | luya\web\jsonld\ThingTrait |
setAlternateName() | An alias for the item | luya\web\jsonld\ThingTrait |
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 |
setDescription() | A description of the item. | luya\web\jsonld\ThingTrait |
setDirector() | A director of e.g. tv, radio, movie, video gaming etc. content, or of an event. | luya\web\jsonld\EventTrait |
setDisambiguatingDescription() | A sub property of description. A short description of the item used to disambiguate from other, similar items. | luya\web\jsonld\ThingTrait |
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 |
setIdentifier() | The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details. | luya\web\jsonld\ThingTrait |
setImage() | An image of the item. | luya\web\jsonld\ThingTrait |
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 |
setMainEntityOfPage() | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. | luya\web\jsonld\ThingTrait |
setMaximumAttendeeCapacity() | The total number of individuals that may attend an event or venue. | luya\web\jsonld\EventTrait |
setName() | The name of the item. | luya\web\jsonld\ThingTrait |
setOffers() | Set Offer | luya\web\jsonld\ThingTrait |
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 |
setSameAs() | URL of a reference Web page that unambiguously indicates the item's identity. | luya\web\jsonld\ThingTrait |
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 |
setSubjectOf() | A CreativeWork or Event about this Thing. | luya\web\jsonld\ThingTrait |
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 |
setUrl() | URL of the item. | luya\web\jsonld\ThingTrait |
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 |
toArray() | Converts the object into an array. | luya\web\jsonld\BaseThing |
typeDefintion() | Contains the jsonLd definton @type value if not null or false. | luya\web\jsonld\Event |
Protected Methods
Method | Description | Defined By |
---|---|---|
extractFieldsFor() | Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id". | yii\base\ArrayableTrait |
extractRootFields() | Extracts the root field names from nested fields. | yii\base\ArrayableTrait |
resolveFields() | Determines which fields can be returned by toArray(). | yii\base\ArrayableTrait |
Method Details
Defined in: yii\base\BaseObject::__call()
Calls the named method which is not a class method.
Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.
public mixed __call ( $name, $params ) | ||
$name | string |
The method name |
$params | array |
Method parameters |
return | mixed |
The method return value |
---|---|---|
throws | yii\base\UnknownMethodException |
when calling unknown method |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
Defined in: yii\base\BaseObject::__construct()
Constructor.
The default implementation does two things:
- Initializes the object with the given configuration
$config
. - Call init().
If this method is overridden in a child class, it is recommended that
- the last parameter of the constructor is a configuration array, like
$config
here. - call the parent implementation at the end of the constructor.
public void __construct ( $config = [] ) | ||
$config | array |
Name-value pairs that will be used to initialize the object properties |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
Defined in: yii\base\BaseObject::__get()
Returns the value of an object property.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $value = $object->property;
.
See also __set().
public mixed __get ( $name ) | ||
$name | string |
The property name |
return | mixed |
The property value |
---|---|---|
throws | yii\base\UnknownPropertyException |
if the property is not defined |
throws | yii\base\InvalidCallException |
if the property is write-only |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter();
} elseif (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in: yii\base\BaseObject::__isset()
Checks if a property is set, i.e. defined and not null.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing isset($object->property)
.
Note that if the property is not defined, false will be returned.
public boolean __isset ( $name ) | ||
$name | string |
The property name or the event name |
return | boolean |
Whether the named property is set (not null). |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
Defined in: yii\base\BaseObject::__set()
Sets value of an object property.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $object->property = $value;
.
See also __get().
public void __set ( $name, $value ) | ||
$name | string |
The property name or the event name |
$value | mixed |
The property value |
throws | yii\base\UnknownPropertyException |
if the property is not defined |
---|---|---|
throws | yii\base\InvalidCallException |
if the property is read-only |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter($value);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
} else {
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
}
Defined in: yii\base\BaseObject::__unset()
Sets an object property to null.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing unset($object->property)
.
Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.
public void __unset ( $name ) | ||
$name | string |
The property name |
throws | yii\base\InvalidCallException |
if the property is read only. |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
}
}
Defined in: yii\base\BaseObject::canGetProperty()
Returns a value indicating whether a property can be read.
A property is readable if:
- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true);
See also canSetProperty().
public boolean canGetProperty ( $name, $checkVars = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
return | boolean |
Whether the property can be read |
---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
Defined in: yii\base\BaseObject::canSetProperty()
Returns a value indicating whether a property can be set.
A property is writable if:
- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true);
See also canGetProperty().
public boolean canSetProperty ( $name, $checkVars = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
return | boolean |
Whether the property can be written |
---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
::class
instead.
Defined in: yii\base\BaseObject::className()
Returns the fully qualified name of this class.
public static string className ( ) | ||
return | string |
The fully qualified name of this class. |
---|
public static function className()
{
return get_called_class();
}
Defined in: yii\base\ArrayableTrait::extraFields()
Returns the list of fields that can be expanded further and returned by toArray().
This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray(). Only when field names to be expanded are explicitly specified when calling toArray(), will their values be exported.
The default implementation returns an empty array.
You may override this method to return a list of expandable fields based on some context information (e.g. the current application user).
See also:
public array extraFields ( ) | ||
return | array |
The list of expandable field names or field definitions. Please refer to fields() on the format of the return value. |
---|
public function extraFields()
{
return [];
}
Defined in: yii\base\ArrayableTrait::extractFieldsFor()
Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
protected array extractFieldsFor ( array $fields, $rootField ) | ||
$fields | array |
The fields requested for extraction |
$rootField | string |
The root field for which we want to extract the nested fields |
return | array |
Nested fields extracted for the given field |
---|
protected function extractFieldsFor(array $fields, $rootField)
{
$result = [];
foreach ($fields as $field) {
if (0 === strpos($field, "{$rootField}.")) {
$result[] = preg_replace('/^' . preg_quote($rootField, '/') . '\./i', '', $field);
}
}
return array_unique($result);
}
Defined in: yii\base\ArrayableTrait::extractRootFields()
Extracts the root field names from nested fields.
Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "item".
protected array extractRootFields ( array $fields ) | ||
$fields | array |
The fields requested for extraction |
return | array |
Root fields extracted from the given nested fields |
---|
protected function extractRootFields(array $fields)
{
$result = [];
foreach ($fields as $field) {
$result[] = current(explode('.', $field, 2));
}
if (in_array('*', $result, true)) {
$result = [];
}
return array_unique($result);
}
Defined in: luya\web\jsonld\BaseThing::fields()
Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
A field is a named element in the returned array by toArray().
This method should return an array of field names or field definitions. If the former, the field name will be treated as an object property name whose value will be used as the field value. If the latter, the array key should be the field name while the array value should be the corresponding field definition which can be either an object property name or a PHP callable returning the corresponding field value. The signature of the callable should be:
function ($model, $field) {
// return field value
}
For example, the following code declares four fields:
email
: the field name is the same as the property nameemail
;firstName
andlastName
: the field names arefirstName
andlastName
, and their values are obtained from thefirst_name
andlast_name
properties;fullName
: the field name isfullName
. Its value is obtained by concatenatingfirst_name
andlast_name
.
return [
'email',
'firstName' => 'first_name',
'lastName' => 'last_name',
'fullName' => function ($model) {
return $model->first_name . ' ' . $model->last_name;
},
];
public array fields ( ) | ||
return | array |
The list of field names or field definitions. |
---|
public function fields()
{
return $this->resolveGetterMethods();
}
Defined in: luya\web\jsonld\EventTrait::getAbout()
public static getAbout ( ) |
public function getAbout()
{
return $this->_about;
}
Defined in: luya\web\jsonld\EventTrait::getActor()
public luya\web\jsonld\Person getActor ( ) |
public function getActor()
{
return $this->_actor;
}
Defined in: luya\web\jsonld\ThingTrait::getAdditionalType()
public string getAdditionalType ( ) |
public function getAdditionalType()
{
return $this->_additionalType;
}
Defined in: luya\web\jsonld\ThingTrait::getAlternateName()
public string getAlternateName ( ) |
public function getAlternateName()
{
return $this->_alternateName;
}
Defined in: luya\web\jsonld\EventTrait::getAttendee()
public luya\web\jsonld\Organization|luya\web\jsonld\Person getAttendee ( ) |
public function getAttendee()
{
return $this->_attendee;
}
Defined in: luya\web\jsonld\EventTrait::getComposer()
public luya\web\jsonld\Organization|luya\web\jsonld\Person getComposer ( ) |
public function getComposer()
{
return $this->_composer;
}
Defined in: luya\web\jsonld\EventTrait::getContributor()
public luya\web\jsonld\Organization|luya\web\jsonld\Person getContributor ( ) |
public function getContributor()
{
return $this->_contributor;
}
Defined in: luya\web\jsonld\ThingTrait::getDescription()
public string getDescription ( ) |
public function getDescription()
{
return $this->_description;
}
Defined in: luya\web\jsonld\EventTrait::getDirector()
public luya\web\jsonld\Person getDirector ( ) |
public function getDirector()
{
return $this->_director;
}
public string getDisambiguatingDescription ( ) |
public function getDisambiguatingDescription()
{
return $this->_disambiguatingDescription;
}
Defined in: luya\web\jsonld\EventTrait::getDoorTime()
public \luya\web\jsonld\DateTime getDoorTime ( ) |
public function getDoorTime()
{
return $this->_doorTime;
}
Defined in: luya\web\jsonld\EventTrait::getDuration()
public \luya\web\jsonld\Duration getDuration ( ) |
public function getDuration()
{
return $this->_duration;
}
Defined in: luya\web\jsonld\EventTrait::getEndDate()
public \luya\web\jsonld\Date|\luya\web\jsonld\DateTime getEndDate ( ) |
public function getEndDate()
{
return $this->_endDate;
}
Defined in: luya\web\jsonld\EventTrait::getFunder()
public luya\web\jsonld\Organization|luya\web\jsonld\Person getFunder ( ) |
public function getFunder()
{
return $this->_funder;
}
Defined in: luya\web\jsonld\ThingTrait::getIdentifier()
public luya\web\jsonld\PropertyValue getIdentifier ( ) |
public function getIdentifier()
{
return $this->_identifier;
}
Defined in: luya\web\jsonld\ThingTrait::getImage()
public luya\web\jsonld\ImageObject getImage ( ) |
public function getImage()
{
return $this->_image;
}
Defined in: luya\web\jsonld\EventTrait::getInLanguage()
public \luya\web\jsonld\Language|\luya\web\jsonld\Text getInLanguage ( ) |
public function getInLanguage()
{
return $this->_inLanguage;
}
Defined in: luya\web\jsonld\EventTrait::getLocation()
public luya\web\jsonld\Place|luya\web\jsonld\PostalAddress|string getLocation ( ) |
public function getLocation()
{
return $this->_location;
}
public luya\web\jsonld\CreativeWork getMainEntityOfPage ( ) |
public function getMainEntityOfPage()
{
return $this->_mainEntityOfPage;
}
public integer getMaximumAttendeeCapacity ( ) |
public function getMaximumAttendeeCapacity()
{
return $this->_maximumAttendeeCapacity;
}
Defined in: luya\web\jsonld\ThingTrait::getName()
public string getName ( ) |
public function getName()
{
return $this->_name;
}
Defined in: luya\web\jsonld\ThingTrait::getOffers()
Get Offer
public luya\web\jsonld\Offer getOffers ( ) |
public function getOffers()
{
return $this->_offers;
}
Defined in: luya\web\jsonld\EventTrait::getOrganizer()
public luya\web\jsonld\Organization|luya\web\jsonld\Person getOrganizer ( ) |
public function getOrganizer()
{
return $this->_organizer;
}
Defined in: luya\web\jsonld\EventTrait::getPerformer()
public luya\web\jsonld\Organization|luya\web\jsonld\Person getPerformer ( ) |
public function getPerformer()
{
return $this->_performer;
}
public string getPreviousStartDate ( ) |
public function getPreviousStartDate()
{
return $this->_previousStartDate;
}
Defined in: luya\web\jsonld\EventTrait::getRecordedIn()
public luya\web\jsonld\CreativeWork getRecordedIn ( ) |
public function getRecordedIn()
{
return $this->_recordedIn;
}
public integer getRemainingAttendeeCapacity ( ) |
public function getRemainingAttendeeCapacity()
{
return $this->_remainingAttendeeCapacity;
}
Defined in: luya\web\jsonld\ThingTrait::getSameAs()
public string getSameAs ( ) |
public function getSameAs()
{
return $this->_sameAs;
}
Defined in: luya\web\jsonld\EventTrait::getSponsor()
public luya\web\jsonld\Organization|luya\web\jsonld\Person getSponsor ( ) |
public function getSponsor()
{
return $this->_sponsor;
}
Defined in: luya\web\jsonld\EventTrait::getStartDate()
public \luya\web\jsonld\Date|\luya\web\jsonld\DateTime getStartDate ( ) |
public function getStartDate()
{
return $this->_startDate;
}
Defined in: luya\web\jsonld\EventTrait::getSubEvent()
public luya\web\jsonld\Event getSubEvent ( ) |
public function getSubEvent()
{
return $this->_subEvent;
}
Defined in: luya\web\jsonld\ThingTrait::getSubjectOf()
public luya\web\jsonld\CreativeWork|luya\web\jsonld\Event getSubjectOf ( ) |
public function getSubjectOf()
{
return $this->_subjectOf;
}
Defined in: luya\web\jsonld\EventTrait::getSuperEvent()
public luya\web\jsonld\Event getSuperEvent ( ) |
public function getSuperEvent()
{
return $this->_superEvent;
}
Defined in: luya\web\jsonld\EventTrait::getTranslator()
public luya\web\jsonld\Organization|luya\web\jsonld\Person getTranslator ( ) |
public function getTranslator()
{
return $this->_translator;
}
Defined in: luya\web\jsonld\EventTrait::getTypicalAgeRange()
public string getTypicalAgeRange ( ) |
public function getTypicalAgeRange()
{
return $this->_typicalAgeRange;
}
Defined in: luya\web\jsonld\ThingTrait::getUrl()
public string getUrl ( ) |
public function getUrl()
{
return $this->_url;
}
Defined in: luya\web\jsonld\EventTrait::getWorkFeatured()
public luya\web\jsonld\CreativeWork getWorkFeatured ( ) |
public function getWorkFeatured()
{
return $this->_workFeatured;
}
Defined in: luya\web\jsonld\EventTrait::getWorkPerformed()
public luya\web\jsonld\CreativeWork getWorkPerformed ( ) |
public function getWorkPerformed()
{
return $this->_workPerformed;
}
Defined in: yii\base\BaseObject::hasMethod()
Returns a value indicating whether a method is defined.
The default implementation is a call to php function method_exists()
.
You may override this method when you implemented the php magic method __call()
.
public boolean hasMethod ( $name ) | ||
$name | string |
The method name |
return | boolean |
Whether the method is defined |
---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
Defined in: yii\base\BaseObject::hasProperty()
Returns a value indicating whether a property is defined.
A property is defined if:
- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true);
See also:
public boolean hasProperty ( $name, $checkVars = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
return | boolean |
Whether the property is defined |
---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
Defined in: yii\base\BaseObject::init()
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
public void init ( ) |
public function init()
{
}
public boolean isAccessibleForFree ( ) |
public function isAccessibleForFree()
{
return $this->_isAccessibleForFree;
}
Defined in: yii\base\ArrayableTrait::resolveFields()
Determines which fields can be returned by toArray().
This method will first extract the root fields from the given fields. Then it will check the requested root fields against those declared in fields() and extraFields() to determine which fields can be returned.
protected array resolveFields ( array $fields, array $expand ) | ||
$fields | array |
The fields being requested for exporting |
$expand | array |
The additional fields being requested for exporting |
return | array |
The list of fields to be exported. The array keys are the field names, and the array values are the corresponding object property names or PHP callables returning the field values. |
---|
protected function resolveFields(array $fields, array $expand)
{
$fields = $this->extractRootFields($fields);
$expand = $this->extractRootFields($expand);
$result = [];
foreach ($this->fields() as $field => $definition) {
if (is_int($field)) {
$field = $definition;
}
if (empty($fields) || in_array($field, $fields, true)) {
$result[$field] = $definition;
}
}
if (empty($expand)) {
return $result;
}
foreach ($this->extraFields() as $field => $definition) {
if (is_int($field)) {
$field = $definition;
}
if (in_array($field, $expand, true)) {
$result[$field] = $definition;
}
}
return $result;
}
Defined in: luya\web\jsonld\BaseThing::resolveGetterMethods()
Find all getter methods.
public array resolveGetterMethods ( ) |
public function resolveGetterMethods()
{
$resolved = [];
$methods = get_class_methods($this);
if (!$methods) {
return [];
}
foreach ($methods as $method) {
if (StringHelper::startsWith($method, 'get', true)) {
$resolved[] = lcfirst(StringHelper::replaceFirst('get', '', $method));
}
}
asort($resolved);
return $resolved;
}
Defined in: luya\web\jsonld\EventTrait::setAbout()
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;
}
Defined in: luya\web\jsonld\EventTrait::setActor()
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;
}
Defined in: luya\web\jsonld\ThingTrait::setAdditionalType()
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax.
This is a relationship between something and a class that the thing is in.
public static setAdditionalType ( luya\web\jsonld\UrlValue $additionalType ) | ||
$additionalType | string |
public function setAdditionalType(UrlValue $additionalType)
{
$this->_additionalType = $additionalType->getValue();
return $this;
}
Defined in: luya\web\jsonld\ThingTrait::setAlternateName()
An alias for the item
public static setAlternateName ( $alternateName ) | ||
$alternateName | string |
public function setAlternateName($alternateName)
{
$this->_alternateName = $alternateName;
return $this;
}
Defined in: luya\web\jsonld\EventTrait::setAttendee()
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;
}
Defined in: 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.
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;
}
Defined in: luya\web\jsonld\EventTrait::setContributor()
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;
}
Defined in: luya\web\jsonld\ThingTrait::setDescription()
A description of the item.
public static setDescription ( $description ) | ||
$description | string |
public function setDescription($description)
{
$this->_description = $description;
return $this;
}
Defined in: luya\web\jsonld\EventTrait::setDirector()
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;
}
Defined in: luya\web\jsonld\ThingTrait::setDisambiguatingDescription()
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 static setDisambiguatingDescription ( $disambiguatingDescription ) | ||
$disambiguatingDescription | string |
public function setDisambiguatingDescription($disambiguatingDescription)
{
$this->_disambiguatingDescription = $disambiguatingDescription;
return $this;
}
Defined in: luya\web\jsonld\EventTrait::setDoorTime()
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;
}
Defined in: luya\web\jsonld\EventTrait::setDuration()
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;
}
Defined in: luya\web\jsonld\EventTrait::setEndDate()
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;
}
Defined in: luya\web\jsonld\EventTrait::setFunder()
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;
}
Defined in: luya\web\jsonld\ThingTrait::setIdentifier()
The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.
public static setIdentifier ( luya\web\jsonld\PropertyValue $identifier ) | ||
$identifier | luya\web\jsonld\PropertyValue |
public function setIdentifier(PropertyValue $identifier)
{
$this->_identifier = $identifier;
return $this;
}
Defined in: luya\web\jsonld\ThingTrait::setImage()
An image of the item.
This can be a URL or a fully described ImageObject.
public static setImage ( luya\web\jsonld\ImageObject $image ) | ||
$image | luya\web\jsonld\ImageObject |
public function setImage(ImageObject $image)
{
$this->_image = $image;
return $this;
}
Defined in: luya\web\jsonld\EventTrait::setInLanguage()
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;
}
Defined in: luya\web\jsonld\EventTrait::setIsAccessibleForFree()
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;
}
Defined in: 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.
public static setLocation ( $location ) | ||
$location | luya\web\jsonld\Place|luya\web\jsonld\PostalAddress|string |
public function setLocation($location)
{
$this->_location = $location;
return $this;
}
Defined in: luya\web\jsonld\ThingTrait::setMainEntityOfPage()
Indicates a page (or other CreativeWork) for which this thing is the main entity being described.
Inverse property: mainEntity.
public static setMainEntityOfPage ( luya\web\jsonld\CreativeWork $mainEntityOfPage ) | ||
$mainEntityOfPage | luya\web\jsonld\CreativeWork |
public function setMainEntityOfPage(CreativeWork $mainEntityOfPage)
{
$this->_mainEntityOfPage = $mainEntityOfPage;
return $this;
}
Defined in: luya\web\jsonld\EventTrait::setMaximumAttendeeCapacity()
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;
}
Defined in: luya\web\jsonld\ThingTrait::setName()
The name of the item.
public static setName ( $name ) | ||
$name | string |
public function setName($name)
{
$this->_name = $name;
return $this;
}
Defined in: luya\web\jsonld\ThingTrait::setOffers()
Set Offer
public static setOffers ( luya\web\jsonld\Offer $offers ) | ||
$offers |
public function setOffers(Offer $offers)
{
$this->_offers = $offers;
return $this;
}
Defined in: luya\web\jsonld\EventTrait::setOrganizer()
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;
}
Defined in: luya\web\jsonld\EventTrait::setPerformer()
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;
}
Defined in: luya\web\jsonld\EventTrait::setPreviousStartDate()
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;
}
Defined in: luya\web\jsonld\EventTrait::setRecordedIn()
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;
}
Defined in: luya\web\jsonld\EventTrait::setRemainingAttendeeCapacity()
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;
}
Defined in: luya\web\jsonld\ThingTrait::setSameAs()
URL of a reference Web page that unambiguously indicates the item's identity.
E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
public static setSameAs ( luya\web\jsonld\UrlValue $sameAs ) | ||
$sameAs | luya\web\jsonld\UrlValue |
public function setSameAs(UrlValue $sameAs)
{
$this->_sameAs = $sameAs->getValue();
return $this;
}
Defined in: luya\web\jsonld\EventTrait::setSponsor()
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;
}
Defined in: luya\web\jsonld\EventTrait::setStartDate()
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;
}
Defined in: luya\web\jsonld\EventTrait::setSubEvent()
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;
}
Defined in: luya\web\jsonld\ThingTrait::setSubjectOf()
A CreativeWork or Event about this Thing.
Inverse property: about.
public static setSubjectOf ( $subjectOf ) | ||
$subjectOf | luya\web\jsonld\CreativeWork|luya\web\jsonld\Event |
public function setSubjectOf($subjectOf)
{
$this->_subjectOf = $subjectOf;
return $this;
}
Defined in: luya\web\jsonld\EventTrait::setSuperEvent()
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;
}
Defined in: 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.
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;
}
Defined in: luya\web\jsonld\EventTrait::setTypicalAgeRange()
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;
}
Defined in: luya\web\jsonld\ThingTrait::setUrl()
URL of the item.
public static setUrl ( luya\web\jsonld\UrlValue $url ) | ||
$url | luya\web\jsonld\UrlValue |
public function setUrl(UrlValue $url)
{
$this->_url = $url->getValue();
return $this;
}
Defined in: luya\web\jsonld\EventTrait::setWorkFeatured()
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;
}
Defined in: luya\web\jsonld\EventTrait::setWorkPerformed()
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;
}
Defined in: luya\web\jsonld\BaseThing::toArray()
Converts the object into an array.
public array toArray ( array $fields = [], array $expand = [], $recursive = true ) | ||
$fields | array |
The fields that the output array should contain. Fields not specified in fields() will be ignored. If this parameter is empty, all fields as specified in fields() will be returned. |
$expand | array |
The additional fields that the output array should contain. Fields not specified in extraFields() will be ignored. If this parameter is empty, no extra fields will be returned. |
$recursive | boolean |
Whether to recursively return array representation of embedded objects. |
return | array |
The array representation of the object |
---|
public function toArray(array $fields = [], array $expand = [], $recursive = true)
{
$array = $this->removeEmptyValues($this->internalToArray($fields, $expand, $recursive));
if ($this->typeDefintion()) {
$array['@type'] = $this->typeDefintion();
}
return $array;
}
Contains the jsonLd definton @type value if not null or false.
public boolean|string typeDefintion ( ) | ||
return | boolean|string |
Generates the @type field. |
---|
public function typeDefintion()
{
return 'Event';
}