EducationalOrganization extends Organization uses PlaceTrait
An educational organization.
Tags
Table of Contents
Constants
- CONTEXT = 'https://schema.org'
- JSON-LD @context declaration for Schema.org.
- JSON_PRIORITY_KEYS = [\org\schema\constants\Schema::AT_TYPE, \org\schema\constants\Schema::AT_CONTEXT, \org\schema\constants\Schema::_KEY, \org\schema\constants\Schema::_FROM, \org\schema\constants\Schema::_TO, \org\schema\constants\Schema::ID, \org\schema\constants\Schema::NAME, \org\schema\constants\Schema::URL, \org\schema\constants\Schema::CREATED, \org\schema\constants\Schema::MODIFIED]
- Defines the priority order of keys when serializing the object to JSON-LD.
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.
- $acceptedPaymentMethod : null|string|array<string|int, mixed>|PaymentMethod|LoanOrCredit
- The payment method(s) that are accepted in general by an organization, or for some specific demand or offer.
- $actionableFeedbackPolicy : string|CreativeWork|null
- For a NewsMediaOrganization or other news-related Organization, a statement about public engagement activities (for news media, the newsroom’s), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
- $active : bool|null
- The active flag.
- $additional : object|array<string|int, mixed>|string|null
- The additional description of the place.
- $additionalProperty : null|array<string|int, mixed>|PropertyValue
- A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.
- $additionalType : array<string|int, mixed>|string|null|object
- An additionalType for the item.
- $address : PostalAddress|string|array<string|int, PostalAddress|string>|null
- Physical address of the item (PostalAddress or any object to describe it).
- $agentInteractionStatistic : InteractionCounter|array<string|int, mixed>|null
- The number of completed interactions for this entity, in a particular role (the 'agent'), in a particular action (indicated in the statistic), and in a particular context (i.e. interactionService).
- $aggregateRating : array<string|int, mixed>|AggregateRating|null
- The overall rating, based on a collection of reviews or ratings, of the item.
- $alternateName : string|object|array<string|int, mixed>|null
- An alias for the item.
- $alumni : array<string|int, mixed>|Person|null
- The alumni(es) of an organization.
- $amenityFeature : array<string|int, mixed>|LocationFeatureSpecification|null
- An amenity feature (e.g. a characteristic or service) of the Accommodation.
- $ape : string|null
- The ape identifier of the organization.
- $areaServed : null|string|Place|GeoShape|AdministrativeArea|array<string|int, mixed>
- The geographic area where a service or offered item is provided.
- $award : array<string|int, mixed>|string|null
- An award won by or for this item.
- $branchCode : string|null
- A short textual code (also called "store code") that uniquely identifies a place of business.
- $brand : null|array<string|int, mixed>|Brand|Organization|string
- The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
- $companyRegistration : null|array<string|int, mixed>|Certification|string
- The official registration number of a business including the organization that issued it such as Company House or Chamber of Commerce.
- $contactPoint : null|ContactPoint|array<string|int, mixed>|string
- A contact point for a person or organization.
- $containedInPlace : array<string|int, mixed>|Place|null
- The basic containment relation between a place and another that it contains.
- $containsPlace : array<string|int, mixed>|Place|null
- The basic containment relation between a place and another that it contains.
- $correctionsPolicy : string|CreativeWork|array<string|int, mixed>|null
- For an Organization (e.g. NewsMediaOrganization), a statement describing (in news media, the newsroom’s) disclosure and correction policy for errors.
- $created : null|string
- Date of creation of the resource.
- $department : null|Organization|array<string|int, mixed>
- A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours).
- $description : string|object|array<string|int, mixed>|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.
- $dissolutionDate : string|null
- The date that this organization was dissolved.
- $diversityPolicy : string|CreativeWork|array<string|int, mixed>|null
- Statement on diversity policy by an Organization e.g. a NewsMediaOrganization.
- $diversityStaffingReport : string|Article|array<string|int, mixed>|null
- For an Organization (often but not necessarily a NewsMediaOrganization), a report on staffing diversity issues.
- $duns : string|null
- The Dun & Bradstreet DUNS number for identifying an organization or business person.
- $email : null|string|PropertyValue|array<string|int, PropertyValue|string>
- The Email address.
- $employee : null|array<string|int, mixed>|Person
- Someone working for this organization.
- $ethicsPolicy : string|CreativeWork|array<string|int, mixed>|null
- Statement about ethics policy, e.g. of a NewsMediaOrganization regarding journalistic and publishing practices, or of a Restaurant, a page describing food source policies.
- $event : null|Event|array<string|int, Event>
- Upcoming or past events associated with this place or organization (legacy spelling; see singular form, event).
- $faxNumber : string|null|array<string|int, PropertyValue|string>|PropertyValue
- The fax number.
- $founder : array<string|int, mixed>|null|Organization|Person
- A person or organization who founded this organization.
- $foundingDate : string|null
- The date that this organization was founded.
- $foundingLocation : Place|string|null
- The place where the Organization was founded.
- $funder : array<string|int, mixed>|null|Organization|Person|string
- A person or organization that supports (sponsors) something through some kind of financial contribution.
- $funding : array<string|int, mixed>|Grant|string|null
- A Grant that directly or indirectly provide funding or sponsorship for this item.
- $geo : null|array<string|int, mixed>|GeoCoordinates|GeoShape
- The geo coordinates of the place (GeoShape or GeoCoordinates).
- $globalLocationNumber : string|null
- The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place.
- $hasCertification : array<string|int, mixed>|Certification|null
- Certification information about a product, organization, service, place, or person.
- $hasCredential : string|array<string|int, mixed>|EducationalOccupationalCredential|null
- A credential awarded to the Person or Organization.
- $hasDriveThroughService : bool|null
- Indicates whether some facility (e.g. FoodEstablishment, CovidTestingFacility) offers a service that can be used by driving through in a car. In the case of CovidTestingFacility such facilities could potentially help with social distancing from other potentially-infected users.
- $hasGS1DigitalLink : string|null
- The GS1 digital link associated with the object.
- $hasMap : string|Map|null
- A URL to a map of the place.
- $hasMemberProgram : array<string|int, mixed>|string|MemberProgram|null
- MemberProgram offered by an Organization, for example an eCommerce merchant or an airline.
- $hasMerchantReturnPolicy : array<string|int, mixed>|MerchantReturnPolicy|null
- Specifies a MerchantReturnPolicy that may be applicable.
- $hasOfferCatalog : array<string|int, mixed>|OfferCatalog|null
- Indicates an OfferCatalog listing for this Organization, Person, or Service.
- $hasPart : string|Thing|array<string|int, Thing>|null
- Indicates an item that this part of this item.
- $hasPOS : array<string|int, mixed>|Place|null
- Points-of-Sales operated by the organization or person.
- $hasShippingService : null|array<string|int, mixed>|ShippingService|string
- Specification of a shipping service offered by the organization.
- $id : null|int|string
- The unique identifier of the item.
- $identifier : string|null
- The identifier of the item.
- $image : string|ImageObject|array<string|int, ImageObject|string>|null
- The image reference of this resource.
- $images : array<string|int, mixed>|null
- Photographs of this place (legacy spelling; see singular form, photo).
- $interactionStatistic : InteractionCounter|array<string|int, mixed>|null
- The number of interactions for the CreativeWork using the WebSite or SoftwareApplication.
- $isAccessibleForFree : bool|null
- A flag to signal that the item, event, or place is accessible for free.
- $isicV4 : string|null
- The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
- $iso6523Code : string|null
- An organization identifier as defined in ISO 6523(-1). The identifier should be in the XXXX:YYYYYY:ZZZ or XXXX:YYYYYYformat.
- $isPartOf : string|Thing|array<string|int, Thing>|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.
- $knowsAbout : null|string|Thing|array<string|int, mixed>
- Of a Person, and less typically of an Organization, to indicate a topic that is known about - suggesting possible expertise but not implying it.
- $knowsLanguage : null|string|Language|array<string|int, mixed>
- Of a Person, and less typically of an Organization, to indicate a known language.
- $latitude : null|int|float
- The latitude of a location. For example 37.42242 (WGS 84).
- $legalAddress : null|string|array<string|int, mixed>|PostalAddress
- The legal address of an organization which acts as the officially registered address used for legal and tax purposes.
- $legalForm : string|array<string|int, mixed>|object|null
- Legal form of the organization.
- $legalName : string|null
- The legal name of the organization
- $legalRepresentative : string|array<string|int, mixed>|Person|null
- One or multiple persons who represent this organization legally such as CEO or sole administrator.
- $leiCode : string|null
- An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
- $license : string|object|null
- A legal document giving official permission to do something with the resource.
- $location : null|string|Place|PostalAddress|VirtualLocation
- The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
- $logo : null|string|ImageObject
- An associated logo.
- $longitude : null|int|float
- The longitude of a location. For example -122.08585 (WGS 84).
- $mainEntityOfPage : string|null
- Indicates a page (or other CreativeWork) for which this thing is the main entity being described.
- $makesOffer : array<string|int, mixed>|Offer|null
- A pointer to products or services offered by the organization or person.
- $maximumAttendeeCapacity : null|int|string
- The total number of individuals that may attend an event or venue.
- $member : null|array<string|int, mixed>|Person|Organization
- A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.
- $memberOf : null|array<string|int, mixed>|Organization|MemberProgramTier|ProgramMembership
- An Organization (or ProgramMembership) to which this Person or Organization belongs.
- $modified : null|string
- Date on which the resource was changed.
- $naics : string|null
- The North American Industry Classification System (NAICS) code for a particular organization or business person.
- $name : int|string|null
- The name of the item.
- $nonprofitStatus : string|DefinedTerm|NonprofitType|null
- Indicates the legal status of a non-profit organization in its primary place of business.
- $numberOfEmployees : QuantitativeValue|null
- The number of employees in an organization, e.g. business.
- $offers : array<string|int, mixed>|Offer|null|Demand
- An offer to provide this item.
- $openingHours : string|null
- The general opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas ',' separating each day. Day or time ranges are specified using a hyphen '-'.
- $openingHoursSpecification : null|array<string|int, mixed>|OpeningHoursSpecification
- The opening hours of a certain place.
- $owner : null|string|Thing
- The owner of this Thing.
- $owns : array<string|int, mixed>|Product|OwnershipInfo|null
- Products owned by the organization or person.
- $parentOrganization : array<string|int, mixed>|Organization|null
- The larger organization that this organization is a subOrganization of, if any.
- $photo : null|array<string|int, mixed>|ImageObject|Photograph
- Photographs of this place (legacy spelling; see singular form, photo).
- $photos : array<string|int, mixed>|null
- Photographs of this organization (legacy spelling; see singular form, photo).
- $potentialAction : array<string|int, mixed>|Action|null
- Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
- $providers : array<string|int, mixed>|null
- The providers of the organization
- $publicAccess : bool|null
- A flag to signal that the Place is open to public visitors. If this property is omitted there is no assumed default boolean value.
- $publisher : string|array<string|int, string|Person|Organization>|Person|Organization|null
- The publisher of the resource.
- $publishingPrinciples : string|CreativeWork
- The publishingPrinciples property indicates (typically via URL) a document describing the editorial principles of an Organization (or individual, e.g. a Person writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies.
- $remainingAttendee : int|null
- The number of the remaining attendee.
- $review : array<string|int, mixed>|Review|null
- A review of the item.
- $sameAs : string|array<string|int, mixed>|null
- URL of a reference Web page that unambiguously indicates the item's identity.
- $seeks : array<string|int, mixed>|Demand|null
- A pointer to products or services sought by the organization or person (demand).
- $service : null|array<string|int, mixed>|Service
- The services provided by a place.
- $skills : array<string|int, mixed>|DefinedTerm|null
- The skills of the organization.
- $slogan : string|object|null
- A slogan or motto associated with the item.
- $smokingAllowed : bool|null
- Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
- $specialOpeningHoursSpecification : null|array<string|int, OpeningHoursSpecification>|OpeningHoursSpecification
- The special opening hours of a certain place.
- $sponsor : array<string|int, mixed>|Person|Organization|null
- 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.
- $subjectOf : null|string|array<string|int, mixed>|CreativeWork|Event
- A CreativeWork or Event about this Thing.
- $subOrganization : Organization|array<string|int, mixed>|null
- A relationship between two organizations where the first includes the second, e.g., as a subsidiary.
- $taxID : string|null
- The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US, the SIRET/SIREN in France or the CIF/NIF in Spain.
- $telephone : string|null|array<string|int, mixed>|PropertyValue
- The telephone number.
- $tourBookingPage : null|string|Thing
- A page providing information on how to book a tour of some Place, such as an Accommodation or ApartmentComplex in a real estate setting, as well as other kinds of tours as appropriate.
- $unnamedSourcesPolicy : string|CreativeWork|array<string|int, mixed>|null
- For an Organization (typically a NewsMediaOrganization), a statement about policy on use of unnamed sources and the decision process required.
- $url : int|string|null
- URL of the item.
- $vatID : string|null
- The Value-added Tax ID of the organization or person.
- $website : array<string|int, mixed>|null|string|Website
- The collection of all websites of this place.
- $atContext : string|null
- The JSON-LD `@context` value.
- $atType : string|null
- The JSON-LD `@type` value.
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.
- withAtContext() : $this
- Sets the internal JSON-LD `@context` attribute.
- withAtType() : $this
- Sets the internal JSON-LD `@type` attribute.
- withJSONLDMeta() : $this
- Initializes both JSON-LD metadata: `@type` and `@context`.
Constants
CONTEXT
JSON-LD @context declaration for Schema.org.
public
mixed
CONTEXT
= 'https://schema.org'
JSON_PRIORITY_KEYS
Defines the priority order of keys when serializing the object to JSON-LD.
public
array<string|int, string>
JSON_PRIORITY_KEYS
= [\org\schema\constants\Schema::AT_TYPE, \org\schema\constants\Schema::AT_CONTEXT, \org\schema\constants\Schema::_KEY, \org\schema\constants\Schema::_FROM, \org\schema\constants\Schema::_TO, \org\schema\constants\Schema::ID, \org\schema\constants\Schema::NAME, \org\schema\constants\Schema::URL, \org\schema\constants\Schema::CREATED, \org\schema\constants\Schema::MODIFIED]
Keys listed here will always appear first in the serialized array, in the order specified. All remaining public properties will be sorted alphabetically after these priority keys.
This ensures that important JSON-LD metadata and system fields
(like @type, @context, _key, id, url, created, modified, etc.)
appear at the top of the output for consistency and readability.
Usage:
$orderedKeys = self::JSON_PRIORITY_KEYS;
Notes:
- Can be overridden in a subclass by redefining the constant.
- Late static binding (
static::JSON_PRIORITY_KEYS) allows child classes to modify the serialization order.
List of JSON-LD keys in priority order.
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
$acceptedPaymentMethod
The payment method(s) that are accepted in general by an organization, or for some specific demand or offer.
public
null|string|array<string|int, mixed>|PaymentMethod|LoanOrCredit
$acceptedPaymentMethod
$actionableFeedbackPolicy
For a NewsMediaOrganization or other news-related Organization, a statement about public engagement activities (for news media, the newsroom’s), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
public
string|CreativeWork|null
$actionableFeedbackPolicy
$active
The active flag.
public
bool|null
$active
$additional
The additional description of the place.
public
object|array<string|int, mixed>|string|null
$additional
Note : this property is a custom attribute of the original Place class defined in http://schema.org/Place.
$additionalProperty
A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.
public
null|array<string|int, mixed>|PropertyValue
$additionalProperty
= null
Attributes
- #[HydrateWith]
- \org\schema\PropertyValue::class
$additionalType
An additionalType for the item.
public
array<string|int, mixed>|string|null|object
$additionalType
$address
Physical address of the item (PostalAddress or any object to describe it).
public
PostalAddress|string|array<string|int, PostalAddress|string>|null
$address
= null
$agentInteractionStatistic
The number of completed interactions for this entity, in a particular role (the 'agent'), in a particular action (indicated in the statistic), and in a particular context (i.e. interactionService).
public
InteractionCounter|array<string|int, mixed>|null
$agentInteractionStatistic
$aggregateRating
The overall rating, based on a collection of reviews or ratings, of the item.
public
array<string|int, mixed>|AggregateRating|null
$aggregateRating
Attributes
- #[HydrateWith]
- \org\schema\AggregateRating::class
$alternateName
An alias for the item.
public
string|object|array<string|int, mixed>|null
$alternateName
$alumni
The alumni(es) of an organization.
public
array<string|int, mixed>|Person|null
$alumni
$amenityFeature
An amenity feature (e.g. a characteristic or service) of the Accommodation.
public
array<string|int, mixed>|LocationFeatureSpecification|null
$amenityFeature
This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
Attributes
- #[HydrateWith]
- \org\schema\LocationFeatureSpecification::class
$ape
The ape identifier of the organization.
public
string|null
$ape
$areaServed
The geographic area where a service or offered item is provided.
public
null|string|Place|GeoShape|AdministrativeArea|array<string|int, mixed>
$areaServed
$award
An award won by or for this item.
public
array<string|int, mixed>|string|null
$award
$branchCode
A short textual code (also called "store code") that uniquely identifies a place of business.
public
string|null
$branchCode
The code is typically assigned by the parentOrganization and used in structured URLs. For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
$brand
The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
public
null|array<string|int, mixed>|Brand|Organization|string
$brand
$companyRegistration
The official registration number of a business including the organization that issued it such as Company House or Chamber of Commerce.
public
null|array<string|int, mixed>|Certification|string
$companyRegistration
$contactPoint
A contact point for a person or organization.
public
null|ContactPoint|array<string|int, mixed>|string
$contactPoint
$containedInPlace
The basic containment relation between a place and another that it contains.
public
array<string|int, mixed>|Place|null
$containedInPlace
$containsPlace
The basic containment relation between a place and another that it contains.
public
array<string|int, mixed>|Place|null
$containsPlace
$correctionsPolicy
For an Organization (e.g. NewsMediaOrganization), a statement describing (in news media, the newsroom’s) disclosure and correction policy for errors.
public
string|CreativeWork|array<string|int, mixed>|null
$correctionsPolicy
$created
Date of creation of the resource.
public
null|string
$created
$department
A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours).
public
null|Organization|array<string|int, mixed>
$department
For example: a store with a pharmacy, or a bakery with a cafe.
$description
A short description of the item.
public
string|object|array<string|int, mixed>|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
$dissolutionDate
The date that this organization was dissolved.
public
string|null
$dissolutionDate
$diversityPolicy
Statement on diversity policy by an Organization e.g. a NewsMediaOrganization.
public
string|CreativeWork|array<string|int, mixed>|null
$diversityPolicy
For a NewsMediaOrganization, a statement describing the newsroom’s diversity policy on both staffing and sources, typically providing staffing data.
$diversityStaffingReport
For an Organization (often but not necessarily a NewsMediaOrganization), a report on staffing diversity issues.
public
string|Article|array<string|int, mixed>|null
$diversityStaffingReport
In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.
$duns
The Dun & Bradstreet DUNS number for identifying an organization or business person.
public
string|null
$duns
The Email address.
public
null|string|PropertyValue|array<string|int, PropertyValue|string>
$email
$employee
Someone working for this organization.
public
null|array<string|int, mixed>|Person
$employee
$ethicsPolicy
Statement about ethics policy, e.g. of a NewsMediaOrganization regarding journalistic and publishing practices, or of a Restaurant, a page describing food source policies.
public
string|CreativeWork|array<string|int, mixed>|null
$ethicsPolicy
In the case of a NewsMediaOrganization, an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.
$event
Upcoming or past events associated with this place or organization (legacy spelling; see singular form, event).
public
null|Event|array<string|int, Event>
$event
$faxNumber
The fax number.
public
string|null|array<string|int, PropertyValue|string>|PropertyValue
$faxNumber
$founder
A person or organization who founded this organization.
public
array<string|int, mixed>|null|Organization|Person
$founder
$foundingDate
The date that this organization was founded.
public
string|null
$foundingDate
$foundingLocation
The place where the Organization was founded.
public
Place|string|null
$foundingLocation
$funder
A person or organization that supports (sponsors) something through some kind of financial contribution.
public
array<string|int, mixed>|null|Organization|Person|string
$funder
$funding
A Grant that directly or indirectly provide funding or sponsorship for this item.
public
array<string|int, mixed>|Grant|string|null
$funding
See also ownershipFundingInfo. Inverse property: fundedItem
$geo
The geo coordinates of the place (GeoShape or GeoCoordinates).
public
null|array<string|int, mixed>|GeoCoordinates|GeoShape
$geo
$globalLocationNumber
The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place.
public
string|null
$globalLocationNumber
The GLN is a 13-digit number used to identify parties and physical locations.
Tags
$hasCertification
Certification information about a product, organization, service, place, or person.
public
array<string|int, mixed>|Certification|null
$hasCertification
Attributes
- #[HydrateWith]
- \org\schema\creativeWork\Certification::class
$hasCredential
A credential awarded to the Person or Organization.
public
string|array<string|int, mixed>|EducationalOccupationalCredential|null
$hasCredential
$hasDriveThroughService
Indicates whether some facility (e.g. FoodEstablishment, CovidTestingFacility) offers a service that can be used by driving through in a car. In the case of CovidTestingFacility such facilities could potentially help with social distancing from other potentially-infected users.
public
bool|null
$hasDriveThroughService
$hasGS1DigitalLink
The GS1 digital link associated with the object.
public
string|null
$hasGS1DigitalLink
This URL should conform to the particular requirements of digital links.
The link should only contain the Application Identifiers (AIs) that are relevant for the entity being annotated,
for instance a Product or an Organization, and for the correct granularity. In particular, for products:
- A Digital Link that contains a serial number (AI 21) should only be present on instances of IndividualProduct
- A Digital Link that contains a lot number (AI 10) should be annotated as SomeProduct if only products from that lot are sold, or IndividualProduct if there is only a specific product.
- A Digital Link that contains a global model number (AI 8013) should be attached to a Product or a ProductModel.
Other item types should be adapted similarly.
Tags
$hasMap
A URL to a map of the place.
public
string|Map|null
$hasMap
$hasMemberProgram
MemberProgram offered by an Organization, for example an eCommerce merchant or an airline.
public
array<string|int, mixed>|string|MemberProgram|null
$hasMemberProgram
$hasMerchantReturnPolicy
Specifies a MerchantReturnPolicy that may be applicable.
public
array<string|int, mixed>|MerchantReturnPolicy|null
$hasMerchantReturnPolicy
Supersedes hasProductReturnPolicy.
$hasOfferCatalog
Indicates an OfferCatalog listing for this Organization, Person, or Service.
public
array<string|int, mixed>|OfferCatalog|null
$hasOfferCatalog
$hasPart
Indicates an item that this part of this item.
public
string|Thing|array<string|int, Thing>|null
$hasPart
$hasPOS
Points-of-Sales operated by the organization or person.
public
array<string|int, mixed>|Place|null
$hasPOS
$hasShippingService
Specification of a shipping service offered by the organization.
public
null|array<string|int, mixed>|ShippingService|string
$hasShippingService
$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|ImageObject|array<string|int, ImageObject|string>|null
$image
$images
Photographs of this place (legacy spelling; see singular form, photo).
public
array<string|int, mixed>|null
$images
$interactionStatistic
The number of interactions for the CreativeWork using the WebSite or SoftwareApplication.
public
InteractionCounter|array<string|int, mixed>|null
$interactionStatistic
The most specific child type of InteractionCounter should be used.
$isAccessibleForFree
A flag to signal that the item, event, or place is accessible for free.
public
bool|null
$isAccessibleForFree
$isicV4
The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
public
string|null
$isicV4
$iso6523Code
An organization identifier as defined in ISO 6523(-1). The identifier should be in the XXXX:YYYYYY:ZZZ or XXXX:YYYYYYformat.
public
string|null
$iso6523Code
$isPartOf
Indicates an item that this item is part of.
public
string|Thing|array<string|int, Thing>|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
$knowsAbout
Of a Person, and less typically of an Organization, to indicate a topic that is known about - suggesting possible expertise but not implying it.
public
null|string|Thing|array<string|int, mixed>
$knowsAbout
We do not distinguish skill levels here, or relate this to educational content, events, objectives or JobPosting descriptions.
Tags
$knowsLanguage
Of a Person, and less typically of an Organization, to indicate a known language.
public
null|string|Language|array<string|int, mixed>
$knowsLanguage
We do not distinguish skill levels or reading/writing/speaking/signing here.
Use language codes from the IETF BCP 47 standard.
$latitude
The latitude of a location. For example 37.42242 (WGS 84).
public
null|int|float
$latitude
Tags
$legalAddress
The legal address of an organization which acts as the officially registered address used for legal and tax purposes.
public
null|string|array<string|int, mixed>|PostalAddress
$legalAddress
= null
The legal address can be different from the place of operations of a business and other addresses can be part of an organization.
$legalForm
Legal form of the organization.
public
string|array<string|int, mixed>|object|null
$legalForm
$legalName
The legal name of the organization
public
string|null
$legalName
$legalRepresentative
One or multiple persons who represent this organization legally such as CEO or sole administrator.
public
string|array<string|int, mixed>|Person|null
$legalRepresentative
$leiCode
An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
public
string|null
$leiCode
$license
A legal document giving official permission to do something with the resource.
public
string|object|null
$license
$location
The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
public
null|string|Place|PostalAddress|VirtualLocation
$location
$logo
An associated logo.
public
null|string|ImageObject
$logo
$longitude
The longitude of a location. For example -122.08585 (WGS 84).
public
null|int|float
$longitude
Tags
$mainEntityOfPage
Indicates a page (or other CreativeWork) for which this thing is the main entity being described.
public
string|null
$mainEntityOfPage
$makesOffer
A pointer to products or services offered by the organization or person.
public
array<string|int, mixed>|Offer|null
$makesOffer
Inverse property: offeredBy
$maximumAttendeeCapacity
The total number of individuals that may attend an event or venue.
public
null|int|string
$maximumAttendeeCapacity
Supersedes capacity
$member
A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.
public
null|array<string|int, mixed>|Person|Organization
$member
$memberOf
An Organization (or ProgramMembership) to which this Person or Organization belongs.
public
null|array<string|int, mixed>|Organization|MemberProgramTier|ProgramMembership
$memberOf
$modified
Date on which the resource was changed.
public
null|string
$modified
$naics
The North American Industry Classification System (NAICS) code for a particular organization or business person.
public
string|null
$naics
$name
The name of the item.
public
int|string|null
$name
$nonprofitStatus
Indicates the legal status of a non-profit organization in its primary place of business.
public
string|DefinedTerm|NonprofitType|null
$nonprofitStatus
$numberOfEmployees
The number of employees in an organization, e.g. business.
public
QuantitativeValue|null
$numberOfEmployees
$offers
An offer to provide this item.
public
array<string|int, mixed>|Offer|null|Demand
$offers
$openingHours
The general opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas ',' separating each day. Day or time ranges are specified using a hyphen '-'.
public
string|null
$openingHours
$openingHoursSpecification
The opening hours of a certain place.
public
null|array<string|int, mixed>|OpeningHoursSpecification
$openingHoursSpecification
Attributes
- #[HydrateWith]
- \org\schema\OpeningHoursSpecification::class
$owner
The owner of this Thing.
public
null|string|Thing
$owner
Represents any entity (person, organization, system, or other object) that can be considered the possessor of this Thing.
$owns
Products owned by the organization or person.
public
array<string|int, mixed>|Product|OwnershipInfo|null
$owns
$parentOrganization
The larger organization that this organization is a subOrganization of, if any.
public
array<string|int, mixed>|Organization|null
$parentOrganization
Inverse property: subOrganization
$photo
Photographs of this place (legacy spelling; see singular form, photo).
public
null|array<string|int, mixed>|ImageObject|Photograph
$photo
A photograph of this place.
$photos
Photographs of this organization (legacy spelling; see singular form, photo).
public
array<string|int, mixed>|null
$photos
$potentialAction
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
public
array<string|int, mixed>|Action|null
$potentialAction
$providers
The providers of the organization
public
array<string|int, mixed>|null
$providers
$publicAccess
A flag to signal that the Place is open to public visitors. If this property is omitted there is no assumed default boolean value.
public
bool|null
$publicAccess
$publisher
The publisher of the resource.
public
string|array<string|int, string|Person|Organization>|Person|Organization|null
$publisher
$publishingPrinciples
The publishingPrinciples property indicates (typically via URL) a document describing the editorial principles of an Organization (or individual, e.g. a Person writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies.
public
string|CreativeWork
$publishingPrinciples
$remainingAttendee
The number of the remaining attendee.
public
int|null
$remainingAttendee
$review
A review of the item.
public
array<string|int, mixed>|Review|null
$review
Attributes
- #[HydrateWith]
- \org\schema\Review::class
$sameAs
URL of a reference Web page that unambiguously indicates the item's identity.
public
string|array<string|int, mixed>|null
$sameAs
E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
$seeks
A pointer to products or services sought by the organization or person (demand).
public
array<string|int, mixed>|Demand|null
$seeks
$service
The services provided by a place.
public
null|array<string|int, mixed>|Service
$service
$skills
The skills of the organization.
public
array<string|int, mixed>|DefinedTerm|null
$skills
$slogan
A slogan or motto associated with the item.
public
string|object|null
$slogan
$smokingAllowed
Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
public
bool|null
$smokingAllowed
$specialOpeningHoursSpecification
The special opening hours of a certain place.
public
null|array<string|int, OpeningHoursSpecification>|OpeningHoursSpecification
$specialOpeningHoursSpecification
Attributes
- #[HydrateWith]
- \org\schema\OpeningHoursSpecification::class
$sponsor
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
array<string|int, mixed>|Person|Organization|null
$sponsor
$subjectOf
A CreativeWork or Event about this Thing.
public
null|string|array<string|int, mixed>|CreativeWork|Event
$subjectOf
$subOrganization
A relationship between two organizations where the first includes the second, e.g., as a subsidiary.
public
Organization|array<string|int, mixed>|null
$subOrganization
$taxID
The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US, the SIRET/SIREN in France or the CIF/NIF in Spain.
public
string|null
$taxID
$telephone
The telephone number.
public
string|null|array<string|int, mixed>|PropertyValue
$telephone
$tourBookingPage
A page providing information on how to book a tour of some Place, such as an Accommodation or ApartmentComplex in a real estate setting, as well as other kinds of tours as appropriate.
public
null|string|Thing
$tourBookingPage
$unnamedSourcesPolicy
For an Organization (typically a NewsMediaOrganization), a statement about policy on use of unnamed sources and the decision process required.
public
string|CreativeWork|array<string|int, mixed>|null
$unnamedSourcesPolicy
$url
URL of the item.
public
int|string|null
$url
$vatID
The Value-added Tax ID of the organization or person.
public
string|null
$vatID
$website
The collection of all websites of this place.
public
array<string|int, mixed>|null|string|Website
$website
$atContext
The JSON-LD `@context` value.
private
string|null
$atContext
= null
Default is https://schema.org.
$atType
The JSON-LD `@type` value.
private
string|null
$atType
= null
This can be manually set or automatically inferred from the class name.
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>
Includes public properties, the JSON-LD @context and @type.
Null values are automatically removed.
Tags
Return values
array<string|int, mixed> —JSON-LD representation of the object.
withAtContext()
Sets the internal JSON-LD `@context` attribute.
public
withAtContext(string $context) : $this
Useful if you need a custom JSON-LD context.
Parameters
- $context : string
-
Optional JSON-LD context.
Return values
$thiswithAtType()
Sets the internal JSON-LD `@type` attribute.
public
withAtType(string $type) : $this
Allows overriding the default type inferred from the class.
Parameters
- $type : string
-
Optional JSON-LD type
Return values
$thiswithJSONLDMeta()
Initializes both JSON-LD metadata: `@type` and `@context`.
public
withJSONLDMeta([string|null $atType = null ][, string|null $atContext = null ]) : $this
Can be called from constructor or later to override default values.
Parameters
- $atType : string|null = null
-
Optional JSON-LD type
- $atContext : string|null = null
-
Optional JSON-LD context